/** * * Ohjelma tulostaa tekstin Hello world! * @author Vesa Lappalainen * @version 1.0, 03.01.2003 */
Jos tiedot annetaan Javan dokumentoinnin standardimuodossa, niin tiedostoista saadaan sitten koostettua helposti HTML-muotoinen dokumentti. JavaDocin mukainen kommentti alkaa "sululla" /** ja päättyy normaaliin kommentin loppumerkkiin.
Kommentointi kannattaa käytännössä tehdä yksittäisten metodien tarkkuudella. Katso esimerkiksi tämän luvun viimeinen esimerkki.
Katso lisää JavaDoc:in käytöstä esimerkiksi:
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html