Ohjelmoinnin harjoitustyön palauttaminen

• palautus tehdään yhdessä zip-pakatussa kansiossa, zipin luominen näytetään tarvittaessa ohjauksissa.
• kaikki palautettava sähköisenä, kaavioista kamerakännykällä otettu kuva (josta saa selvää) riittää.
• palautus tehdään sähköpostilla oman ryhmän ohjaajalle viimeistään viimeisen opetusviikon sunnuntaina.
• palautetussa versiossa kaavioiden, JUnit-testitapausten, Javadoc:in ja muun dokumentoinnin on oltava ajantasalla!

Palautuksen kansiorakenne

• kansiolle nimeksi palauttajan nimi muodossa sukunimi_etunimi
  • projekti (Netbeansin projektihakemisto kokonaisuudessaan!)
  • javadoc (Generoitu dokumentaatio, yleensä valmiiksi projektihakemistossa!)
  • oma dokumentointi
    • aiheenKuvausJaRakenne.pdf
    • testausdokumentti.pdf
    • käyttöohjeet.pdf

Dokumentaation vaatimukset

• aiheen kuvaus
  • ks viikon 1 milestone
• rakenne
  • kaikkien aikaisemmin tehtyjen kaavioiden viimeisimmät ja toteutusta vastaavat versiot
  • ohjelman rakenne kuvailtu oleellisin osin sanallisesti.  Kuvauksesta tulee ilmetä miten suorituspolku ohjelman sisällä etenee ohjelmaa käytettäessä
  • kuvauksessa tulee viitata kaavioihin, pelkät kaaviot eivät kuitenkaan riitä, kaavioiden pääideat on kommunikoitava myös sanallisesti
• testausdokumentti
  • Rajoitteet
    • kuinka suurilla syötteillä ohjelmaa on testattu, esim. levykirjastoon on talletettu 20,000 levyä
    • miten syötteen koko vaikuttaa ohjelman käyttämiseen
  • JUnit-yksikkötestien kattavuus
    • mitkä osa-alueet (luokat) on testattu
    • mitä on jäänyt testaamatta
• käyttöohjeet
  • miten ohjelmaa käytetään niiltä osin, kun se ei ole itsestään selvää
• javadoc
  • ainoastaan itsestään selvät kuten getterit ja setterit voidaan jättää dokumentoimatta

PS. Mikäli haluat voit luoda työstäsi NetBeanssissä myös ns. jar-paketin, mikä voidaan suorittaa javatulkilla ilman NetBeans-ympäristöä. Java-ohjelman saa ajettavaksi jar-paketiksi NetBeanssissa seuraavasti:

1. klikkaa hiiren oikealla projektia
2. valitse "Clean and Build"
3. tämän jälkeen projektin hakemistossa on dist-kansio, jonka sisällä on projektinnimi.jar -tiedosto

Huomaa, että pelkän jar-paketin palautus ei riitä työn palautukseksi.