Question

A házihoz kell készíteni részletes dokumentációt? A kiírásnál nincs kérve, de az oldalon több helyen találtam rá utalást

Answer 1

Nem szükséges, viszont legyen tagolt, kommentelt kód (nem kell agyonkommentelni), a tesztesetek legyenek szisztematikusak és megtervezettek (bemenet, teszt, elvárt kimenet, valós kimenet).

Esetleg teszteléshez egy tesztelési jegyzőkönyvet készíthetsz, mert akkor a javítók már látják, hogy milyen tesztesetekre gondoltál, és hogyan tesztelted a kódodat.

Comments

Annyit fűznék még hozzá, hogy a jegyzőkönyvet sem kell túlzásba vinni, elég ha egy szöveges fájlba összegyűjtöd, hogy milyen bemenetre, milyen utasítással hívtad meg a szkriptet, mit kaptál és egy egymondatos értékelés, hogy ez megfelel-e az elvárt kimenetnek vagy nem.

---

Engem csak az tévesztett meg, hogy itt: https://inf.mit.bme.hu/edu/other/documentation
le van írva, hogy mennyire fontos a dokumentáció, sőt még sablon is van a házihoz.  Így nem egyértelmű, hogy mi az elvárás.

---

Régebbi években volt külön dokumentáció is, de egy pár éve már nincsen az IRF-ben.

Más tárgyakban viszont kérünk dokumentációt, abban és pl. az önálló labor dokumentáció elkészítésében segít a fenti oldal.