Comments háromféleképpen dokumentálja a java
Tegyük fel, hogy dolgozik az informatikai osztály egy nagy cég. A főnök utasítja, hogy kell írni egy programot, amely több ezer sornyi forráskódot. Néhány hét után befejezte a programot, és futtassa a projektet. Néhány hónap múlva az emberek kezdenek észre, hogy a program néha esik. Azt kifogásolják, hogy a főnök, és ő viszont azt mondja, meg kell javítani. Keresés a projekt fájlt találsz egy mappát szöveges fájlok - forráskódját. Sajnos, akkor kiderül, hogy a forráskód nincs értelme - ez egyszerűen nem érti. Az utóbbi időben már dolgozik más projektek, és nem emlékszik, miért írta a kódot, hogy így. Megfejtése a kódot több óráig is eltarthat, vagy akár napok, de a főnök akar eredményeket tegnap. Jelentős stressz elkerülhetetlen. Hogyan tudnám, hogy ez megtörténjen?
Ez a stressz lehet kerülni, ha a forráskód dokumentálása jelentős leírásokat. És bár gyakran figyelmen kívül hagyott, de a dokumentáció a forráskód az írás a program logikáját - ez az egyik legfontosabb feladat a fejlesztő. Mint látható, az én például, figyelembe véve, hogy mennyi idő telt el azóta, az írás a kódot, akkor a bírság programozó nem érti a logikai bizonyos döntések -, hogy miért, és nem másként.
Tekintsük az általánosan használt Javadoc címkék:
A létrehozott dokumentációt magukban foglalnak egy indexfájlt (index.html), amely a kiindulási oldalon. Például az alábbi ábrán láthatjuk a kezdőlap dokumentáció Java SE 8 frissítés 45 API-könyvtárat Javadoc.
