Deadline-2.md

Deadline 2

Aloita ohjelmointi

• Toteuta projektia pieninä paloina
• Aloita oleellisesta ohjelmalogiikasta, älä käyttöliittymästä tai ulkoasusta
• Lähde liikkeelle yksinkertaisesta toteutuksesta

Clean Code

• Koodin tulisi alusta lähtien olla siistiä ja laajennettavaa
• Tutustu kurssin määrittelemiin koodin laatuvaatimuksiin

JUnit-yksikkötestit:

• Ohjelman testien tulisi alusta lähtien olla kattavia
  • Testaa mahdollisimman montaa luokkaa
  • Testaa mahdollisimman montaa metodia
  • Testaa mahdollisimman monelta kantilta
  • Huomioi koodin laatuvaatimuksien alakohta Testaus
• Ainakin 10 testiä valmiina

Dokumentaatio

Generoi PIT-raportti

• Katso täältä ohjeet raportin generointiin
• Kopioi generoitu raportti kansiosta target/pit-reports/<aikaleima>/ kansioon dokumentaatio/pit/.

Checkstyle

• Generoidaan tällä viikolla myös Checkstyle-raportti
• Generoi Checkstyle-raportti
• Vilkaise raportti läpi ja korjaa kaikki esiintyvät virheet.
• Whitespace-virheiden kanssa auttaa NetBeansin macro Alt-Shift-F, tai vastaava hiiren oikeaklikkaus -> Format, joka korjaa useimmat yleiset whitespace-virheet.
• Viikon lopuksi generoi uusi Checkstyle-raportti ja kopioi raportin kansion target/site/ sisältö kokonaisuudessaan dokumentaatiohakemistoon omaan kansioonsa (dokumentaatio/checkstyle/).

README.md

• Sijaitsee repositorion juuressa
• Lisää tiedostoon lyhyt tiivistelmä aihekuvausestasi
• Tee Dokumentaatio -alaotsikko ja linkkaa sen alla projektisi aiheen kuvaus ja määritelmä sekä tuntikirjanpitosi
• Voit kirjoittaa linkin markdownilla esimerkiksi näin: [aiheen kuvaus](dokumentaatio/aiheenKuvausJaRakenne.md)
• Muista käyttää markdownia tiedoston tyylittelyyn
• Tulevien viikkojen dokumentaatiot, kuten rakennekuvaus ja testausdokumentaatio, tulee vastaavasti linkittää README.md:ssä tulevaisuudessa.

Luokkakaavio

• Piirrä ohjelmalla tai käsin (mieluiten ohjelmalla)
  • Skannaa tai ota selkeä kuva käsinpiirretystä
  • Kiinnitä huomiota luokkakaavion selkeyteen, hyvä käsiala
• Palauta .png tai .jpg -tiedostomuodossa
• Hahmottele ensimmäinen versio ohjelmastasi
• Määrittelyvaiheen luokkakaavio
• Luokkakaavioon järjestelmän tärkeimmät luokat
• Luokkien nimet ja yhteydet riittää
• Lisää luokkakaavio kuvana seuraavien ohjeiden mukaisesti dokumentaatiosi aiheenKuvausJaRakenne.md tiedostoon.

Piirtotyökaluja

Kurssiin soveltuvia piirtotyökaluja ovat:

• https://www.draw.io/ yleispätevä piirtotyökalu kaikkiin kurssilla vaadittaviin kaavioihin
• http://yuml.me/ luokka- ja käyttötapauskaavioihin
• https://www.websequencediagrams.com/ sekvenssikaavioihin