Javadoc

Javadoc ist ein Dokumentationsgenerator für die Programmiersprache Java, mit dem sich automatisch API-Dokumentation aus Quelltext und speziellen Kommentaren erstellen lässt. Javadoc-Kommentare werden mit /** ... */ gekennzeichnet und enthalten spezielle Tags wie @param, @return oder @author, um die Dokumentation zu strukturieren.

Funktionsweise

Javadoc analysiert den Java-Quellcode und erstellt daraus HTML-Dokumentation, die Klassen, Methoden, Parameter und Rückgabewerte beschreibt. Die Dokumentation kann über einen Webbrowser betrachtet werden und dient Entwicklern als wichtige Referenz.

Beispiel

/**

Berechnet die Summe zweier Zahlen.

@param a erste Zahl

@param b zweite Zahl

@return Summe von a und b
*/
public int addiere(int a, int b) {
return a + b;
}