Einführung in JavaDoc

JavaDoc.md

JavaDoc

In Java kann man Kommentare nutzen, um den Code zu beschreiben. Verwendet man eine spezielle Formatierung, welche von JavaDoc vorgegeben ist, lassen sich diese Dokumentationen auch als HTML-Datei ausgeben und werden für die Autovervollständigung im Editor/IDE genutzt. Mit JavaDoc lässt sich jede Eigenschaft des Codes dokumentieren, u.a. Methoden, Klassen, Attribute, Parameter, Rückgabewerte, Fehler, ...

Beispiel

/**
* Beschreibung der Klasse HelloWorld
* @author  Tim Max
* @version 1.0
* @since   2018-04-20 
*/
public class HelloWorld {
    /**
    * Beschreibung der Methode main
    * @param args Beschreibung des Parameters args
    */
    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
   
    /**
    * Beschreibung der Methode go
    * @param x Beschreibung des Parameters x
    * @return Beschreibung des Rückgabe-Parameters (hier: y)
    * @exception Exception Beschreibung des Fehlers 
    * @see Exception
    */
    public int go(int x) throws Exception{
        return y;
    }
}

Tags

Einige der möglichen Tags/Stichworte werden hier aufgelistet:

Tag	Beschreibung
@author	Name des Programmieres
@version	Version des Programmes
@param	Beschreibung des Parameters param
@return	Beschreibung des Rückgabewertes
@exception	Beschreibung eines Fehlers
@see	Aufrufen eines JavaDoc einer anderen Klasse

Aufbau

Damit ein Tag/Stichwort als JavaDoc registriert wird, muss das verwendete Kommentar wie folgt aufgebaut sein:

\**
* @tags
*\

Außerdem starten Tags immer mit dem Zeichen @. Die Kommentarbereiche befinden sich nie in den Funktionen, sondern immer nur in den Klassen und an dem Start des Dokumentes.

Mehr

Auf der Seite TutorialsPoint kann man sich weiter über JavaDoc informieren sowie weitere Tags nachlesen.