JavaDoc

JavaDoc ist ein kleines Werkzeug aus dem JDK, mit dem sich aus speziellen Kommentaren im Quellcode eines Java-Programmes Dokumentationstexte im HTML-Format generieren lassen.

Kommentar-Tags

• @value - dokumentiert ein an eine Methode übergebenes Argument. (hier am Bsp. einer Variable value)
• @return - dokumentier den Rückgabewert einer Methode.
• @see - dient zum Verweisen (Link) auf einen weiterführenden Text in einer (anderen) Dokumentation (Bsp.: @see javax.swing.JButton#setText() )
• @since - dient zur Hervorhebung der Einführung in den Code, also seit wann (z.B. Versionsnummer) ein bestimmtes Feature verfügbar ist.
• @deprecated - dient zum Kennzeichnen veralteter Methode, die nicht mehr eingesetzt werden sollten.
• - dient zum Formatieren von Code-Beispielen innerhalb der JavaDoc. (Bsp.: BeispielCode bc = new BeispielCode(); )

Beispiel

Ein kleines Beispiel soll die Dokumentation einer Methode verdeutlichen: <code=java>/**

* Gibt das Ergebnis der Addition, der im übergebenen int-Array enthaltenen Zahlen zurück.
* @intArr ein Array mit Zahlen im primitiven Datentyp int.
* @return Ergebnis der Addition.
*/

public int addition(int[] intArr) {

  int x = 0;

  for(int i = 0; i < intArr.length; i++) {
     x += intArr[i];
  }

  return x;

}</code=java> Die Erzeugung der Dokumentation aus den JavaDoc-Kommentaren kann nun mit folgendem Befehl in der Kommandozeile des Betriebssystems ausgelöst werden:
javadoc Klassenname.java