Jelenlegi hely

24.3. Megjegyzések

A Java programok kétféle megjegyzést alkalmaznak: dokumentációs és implementációs megjegyzést. Az utóbbi a C++ nyelvhez hasonló, míg az előbbi a Java specialitása. (Megjegyzés: Ezt a bevált ötletet a PHP is átvette.) A dokumentációs megjegyzés /** és */ közötti karaktersorozat. A javadoc segédprogram képes ez alapján automatikusan generálni HTML alapú, teljesen hipertext felépítésű dokumentációt.

A dokumentációs megjegyzés a forráskódot dokumentálja olyan megközelítésben, hogy az alapján a későbbi megértés, az osztály felhasználása maradéktalanul megoldható legyen a kód kézzel történő végignézése nélkül is.