Eine Dokumentation ist praktisch und macht auch gar nicht so viel Aufwand, wie man denkt.
Wie?
Das möchte ich in dem Artikel kurz erklären.
Hat man sein Java-Code ordentlich nach dem JavaDoc Richtlinien und den entsprechenden Tags dokumentiert und möchte nun eine Dokumentation erzeugen, kann man das wie folgt machen:
Project -> Generate JavaDoc
Oben in der Zeile Javadoc command muss als erstes das Tool javadoc.exe aus dem Java SDK gesucht werden.
(javadoc.exe ist im “bin”-Ordner des JDK Verzeichnisses zu finden.)
Nun kann noch ein Speicherort gewählt werden und die Klassen und Pakete, aus denen eine Dokumentation erstellt werden soll.
Die wichtigsten JavaDoc-Tags:
Für die Klasse:
@author Name des Autors
@version Version der Klasse oder des Interface
@since Die JDK-Version
Für Methoden:
@param ParameterName Beschreibung des Parameters
(Kann mehrere Male für eine Methode vorkommen. So oft, wie sie Parameter besitzt.)
@return Beschreibung des Returnwertes
@exception Klassenname der Exception Beschreibung der Exception
@throws Klassenname der Exception Beschreibung der Exception
Zusätzlich können noch HTML-Tags verwendet werden, um die Dokumentation weiter zu strukturieren.