JavaDoc

Aus Byte-Welt Wiki
Zur Navigation springenZur Suche springen

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.
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