Ohjelmoinnin peruskurssi Y2, kurssimateriaali

Projektin viimeistely ja palautus

«  Projektityön dokumentti   ::   Etusivulle   ::   Projektin arvostelusta  »

Projektin viimeistely ja palautus

Siisti koodisi ja lue(tuta) dokumenttisi läpi

Ennen palauttamista kannattaa projektin koodi käydä vielä kertaalleen läpi, lisätä kommentteja sinne, missä niitä ehkä tarvitaan, poistaa poiskommentoitua tarpeetonta koodia jne. Muuttujien tms. nimeäminen uudelleen selkeämmin nimetyiksi on riskaabelia touhua juuri ennen palautusta. Jos päätät tehdä tällaista, muista tallentaa työsi versionhallintaan ennen muutoksia ja testaa koodin toimivuus myös muutosten jälkeen.

Katsele myös dokumentti läpi, ja jos mahdollista, pyydä kaveria lukemaan se. Omat kirjoitusvirheet ja itsestäänselvinä pidetyt asiat näkyvät toiselle paljon paremmin kuin itselle.

Palauttaminen Gitin avulla

Mikäli olet käyttänyt Gitiä projektin tekoon, ei erillistä palautuspakettia tarvi tehdä ja laittaa Rubyriciin. Git-repon tulee sisältää ohjeiden mukainen projektidokumentti (PDF) mahdollisine liitteineen sekä projektin lähdekoodi. Huolehdi siitä, että kaikki arviointiin tarvittava löytyy helposti reposta.

Palautuksen sisältö ilman Gitiä

Mikäli et käytä GIT:iä, toimi seuraavasti:

Palautettavan paketin tulee sisältää ohjeiden mukainen projektidokumentti (PDF) mahdollisine liitteineen sekä projektin lähdekoodi. Laita lähdekoodi erilliseen hakemistoon (esim. src (Eclipsessä tämä tulee oletusarvoisesti)), jotta on helpompi erottaa dokumentin tiedostot lähdekoodista ja muista ohjelman käyttämistä tiedostoista.

Lähdekoodin lisäksi kannattaa varmistaa, että palautukseen tulee mukaan myös kaikki mahdolliset datatiedostot, joita projekti tarvitsee (erityisesti testidata ohjelmissa joiden toiminnan testaaminen vaatii datan syöttämistä, jotta ohjelman toimintaan voi mielekkäästi tutustua). Tee työstä assarillesi helppo tutustua.

Voit tehdä ZIP/JAR-paketin käyttöjärjestelmän toiminnoilla, Eclipsellä, erillisellä ohjelmalla 7-Zip, Winzip jne... Eclipsen tapauksessa voit tiputtaa dokumentin projektin kansioon ja valita Export->Archive File Tarkemmat ohjeet tähän alla.

Tarkista (pura ja kokeile) palauttamasi paketti ennen kuin laitat sen järjestelmään avaamalla se (mielellään toisella tietokoneella). Usein palautuksesta saattaa vahingossa unohtua jokin dokumentin kuva, ohjelmasi tarvitsema tiedosto tms.

Ennen palauttamista sinun tulee paketoida ohjelma ZIP/JAR-pakettiin, mikä onnistuu Eclipsessä esimerkiksi näin:

  1. Varmista, että olet tallentanut juuri sen version ohjelmastasi, jonka haluat palauttaa.
  2. Lisää projektidokumentti (PDF) Eclipsessä projektisi juureen, jotta se tulee mukaan pakettiin.
  1. Lisää myös mahdolliset datatiedostot jne. mikäli ne eivät jo ole projektikansiossa
  1. Valikosta: File ‣ Export...
  2. Avautuvassa pikkuikkunassa: General ‣ Archive File
  3. Paina Next.
  4. Rastita projektisi vasemman reunan projektiluettelosta.
  5. Valitse kansio ja nimi zip-paketille kohtaan To archive file. Nimi voi olla vaikkapa Labyrintti_12345X.zip, jossa 12345X on opiskelijanumerosi.
  6. Paina Finish.
  7. Tutki luomasi zip-paketin sisältö varmistaaksesi, että kaikki sujui oikein. Paketin pitäisi sisältää koko projekti lähdekoodeineen ja dokumentteineen.

Rubyric

Palauta tästä:.

Projektidemo

Projektidemot pidetään 9.-13.5.2016. ja tarpeen vaatiessa myös sitä seuraavalla viikolla. Esittelytilaisuus muistuttaa suunnitelman esittelytilaisuutta. Tässä tilaisuudessa opiskelija esittelee toimivan ohjelmansa sekä projektin dokumentaation assistentille. Varmista tarvittaessa, että projektisi toimii luokan T7 koneissa. Demo kestää n. 25min.

«  Projektityön dokumentti   ::   Etusivulle   ::   Projektin arvostelusta  »