„A programozás alapjai 1 (régi)” változatai közötti eltérés
| 62. sor: | 62. sor: | ||
#Főbb algoritmusok leírása: Le kell írni, hogy milyen algoritmussal (vagy függvénnyel) mit akarunk elérni, és azt hogy ezt milyen lépéseken keresztül érjük el, és mindezt viszonylagos részletességgel. Általában nem kérik az adatkiírás, és adatbekérés algoritmusát, de bármilyen más keresést, kiválasztást, számítást igen. | #Főbb algoritmusok leírása: Le kell írni, hogy milyen algoritmussal (vagy függvénnyel) mit akarunk elérni, és azt hogy ezt milyen lépéseken keresztül érjük el, és mindezt viszonylagos részletességgel. Általában nem kérik az adatkiírás, és adatbekérés algoritmusát, de bármilyen más keresést, kiválasztást, számítást igen. | ||
#A végső dokumentáció: A dokumentációnak olyannak kell lennie, hogy ha valaki más ugyanezzel a problémával kezdd el foglalkozni, és látja a dokumentációt, akkor egyéb kérdés nélkül ''reprodukálni'' tudná a házit (ami többé kevésbé megegyezne a hallgatóéval). Egyébként csak össze kell fűzni az előzőeket és kiegészíteni a tesztelés résszel. A tesztelés részben csak azt kell leírni, hogy milyen, és miért pont azokkal az adatokkal teszteltél. | #A végső dokumentáció: A dokumentációnak olyannak kell lennie, hogy ha valaki más ugyanezzel a problémával kezdd el foglalkozni, és látja a dokumentációt, akkor egyéb kérdés nélkül ''reprodukálni'' tudná a házit (ami többé kevésbé megegyezne a hallgatóéval). Egyébként csak össze kell fűzni az előzőeket és kiegészíteni a tesztelés résszel. A tesztelés részben csak azt kell leírni, hogy milyen, és miért pont azokkal az adatokkal teszteltél. | ||
Van egy másikfajta dokumentálási módszer a doxygen nevű programmal, amihez a kódot és a kommenteket kell úgy alakítani, hogy azt a doxygen értelmezni tudja. Ehhez segítség .......-ebb található. | Van egy másikfajta dokumentálási módszer a doxygen nevű programmal, amihez a kódot és a kommenteket kell úgy alakítani, hogy azt a doxygen értelmezni tudja. Ez a program csinál akkor belőle dokumentációt html, vagy pdf formátumban. Ehhez segítség .......-ebb található. | ||
Doxygen hiány | Doxygen hiány | ||