Infoportal
Dies ist eine alte Version des Dokuments!
JavaDoc
JavaDoc ist ein Software-Dokumentationswerkzeug, welches das automatische Erstellen von HTML-Dokumentationsseiten ermöglicht. Es wurde von Sun Microsystems entwickelt und ist Bestandteil des Java Developer Kits.
Funktionsweise
JavaDoc parst den Java-Quellcode und generiert daraus automatisch HTML-Dokumente. Dazu sind jedoch spezielle JavaDoc-Kommentare notwendig (beginnend mit /**). Die Position dieser Kommentare gibt wie gewohnt an zu was der Kommentar gehört: immer zum nachfolgenden Block. Im Kommentar können spezielle JavaDoc-Tags verwendet werden.
JavaDoc-Tags
| Tag & Parameter | Beschreibung | Verwendbar in |
|---|---|---|
@author name | Beschreibt den Autor | Klasse, Interface |
@version version | Erzeugt einen Versionseintrag. Darf max. einmal pro Klasse oder Interface verwendet werden. | Klasse, Interface |
@see reference | Erzeugt einen Link auf ein anderes Element der Dokumentation. | Klasse, Interface, Instanzvariable, Methode |
@param name description | Parameterbeschreibung einer Methode. | Methode |