palacsint weblapja

A program fontos része a dokumentáció, készítését ajánlatos a program írásával egy időben elkezdeni. Ez egyrészt már a program első sorainak elkészültétől segíti a programozót, programozókat, másrészt nem marad az állandóan csúszásban lévő projekt végére, amikor leginkább az ilyen feladatokon szokás időt nyerni.

Az általam használt dokumentációkészítő program, a phpDocumentor a php fájlok forráskódjába írt speciális megjegyzésekből állítja össze a dokumentációt, amelyet PDF és többféle HTML formátumban képes elmenteni. Mivel a dokumentáció közvetlenül a forráskódok mellett foglal helyet, a forrás módosításával ez is rögtön frissíthető, tehát a dokumentáció mindig aktuális marad.

A phpDocumentor segítségével készített HTML fájlok a webre is kitehetőek. Ezeken weboldalakon egy függvényre vagy változóra kattintva a hozzájuk tartozó forráskód is megjelenik. Az így készített dokumentáció dolgozatom mellékletében is megtalálható.