JavaDoc

2003. január 22.

Tegnapi formázásról szóló beszólásom közben jöttem rá, hogy külön tudomány a megfelelő megjegyzések, illetve dokumentációs megjegyzések készítése, melyről szintén van egy cikk a Sunnál.

A Java forrásban található dokumentációs megjegyzésekből a JavaDoc tool készít dokumentációt. A JavaDoc definiál egy ún. Doclet API-t, melyet használva saját dokumentációs eszközöket készíthetünk. Persze rengeteg docletet találhatunk, melyek a dokumentációt különböző formátumban gyártják (HTML, XML, PDF, RTF, DocBook, TeX), illetve ellenőrzik, hogy nem-e hiányzik valahonnan a dokumentációs megjegyzés, így a generált dokumentációban nem lehet üres folt. Persze vannak eszközök speciális osztályok speciális dokumentálására is, pl. JavaBeanek, illetve szervletek esetén.