6.14 Dokumentationskommentare mit JavaDoc

Die Dokumentation von Softwaresystemen ist ein wichtiger, aber oft vernachlässigter Teil der Softwareentwicklung. Im Entwicklungsprozess müssen die Entwickler Zeit in Beschreibungen der einzelnen Komponenten investieren, besonders dann, wenn weitere Entwickler diese Komponenten in einer öffentlichen Bibliothek anderen Entwicklern zur Verfügung stellen und diese Komponenten wieder verwenden. Um die Klassen und Funktionen gut zu finden und nutzen zu können, müssen die Schnittstellen sorgfältig beschrieben werden. Wichtig bei der Beschreibung sind der Klassenname, der Methodenname, die Art und Anzahl der Parameter, die Wirkung der Funktionen und das Laufzeitverhalten. Da das Erstellen einer externen Dokumentation – also einer Beschreibung außerhalb der Quellcodedatei – fehlerträchtig und deshalb nicht gerade motivierend für die Beschreibung ist, werden spezielle Dokumentationskommentare in den Java-Quelltext eingeführt. Ein spezielles Programm generiert aus den Kommentaren Beschreibungsdateien – im Allgemeinen HTML – mit den gewünschten Informationen. [Die Idee ist nicht neu. In den Achtzigerjahren verwendete Donald E. Knuth das WEB-System zur Dokumentation von TeX. Das Programm wurde mit den Hilfsprogrammen weave und tangle in ein Pascal-Programm und eine TeX-Datei umgewandelt. ]

6.14.1 Einen Dokumentationskommentar setzen

In einer besonders ausgezeichneten Kommentarumgebung werden die Dokumentationskommentare (»Doc Comments«) eingesetzt. Die Kommentarumgebung erweitert einen Blockkommentar und ist vor allen Typen (Klassen, Schnittstellen, Aufzählungen) sowie Methoden und Variablen üblich.

Im folgenden Beispiel gibt JavaDoc Kommentare für die Klasse, Attribute und Methoden an.

Listing 6.112 com/tutego/insel/javadoc/Room.java

package com.tutego.insel.javadoc; 
 
/** 
 * This class models a room with a given number of players. 
 */ 
public class Room 
{ 
  /** Number of players in a room. */ 
  private int numberOfPersons; 
 
  /** 
   * A person enters the room. 
   * Increments the number of persons. 
   */ 
  public void enterPerson() { 
    numberOfPersons++; 
  } 
 
  /** 
   * A person leaves the room. 
   * Decrements the number of persons. 
   */ 
  public void leavePerson() { 
    if ( numberOfPersons > 0 ) 
      numberOfPersons--; 
  } 
 
  /** 
   * Gets the number of persons in this room. 
   * This is always greater equals 0. 
   * 
   * @return Number of persons. 
   */ 
  public int getNumberOfPersons() { 
    return numberOfPersons; 
  } 
}

/** 
 * Ein kurzer Satz, der im Abschnitt "Method Summary" stehen wird. 
 * Es folgt die ausführliche Beschreibung, die später im 
 * Abschnitt "Method Detail" erscheint, aber nicht in der Übersicht. 
 */ 
public void foo() { }

Weil ein Dokumentationskommentar /** mit /* beginnt, ist es für den Compiler ein normaler Blockkommentar. Die JavaDoc-Kommentare werden oft optisch aufgewertet, indem am Anfang jeder Zeile ein Sternchen steht – dieses ignoriert JavaDoc.

6.14.2 Mit javadoc eine Dokumentation erstellen

Aus dem mit Kommentaren versehenen Quellcode generiert ein externes Programm die Zieldokumente. Sun liefert beim SDK das Konsolen-Programm javadoc mit, dem als Parameter ein Dateiname der zu kommentierenden Klasse übergeben wird; aus compilierten Dateien können natürlich keine Beschreibungsdateien erstellt werden. Wir starten javadoc im Verzeichnis, in dem auch die Klassen liegen, und erhalten unsere HTML-Dokumente.

$ javadoc *.java

JavaDoc geht durch den Quelltext, parst die Deklarationen und zieht die Dokumentation heraus. Daraus generiert das Tool eine Beschreibung, die in der Regel als HTML-Seite zu uns kommt.

6.14.3 HTML-Tags in Dokumentationskommentaren

In den Kommentaren können HTML-Tags verwendet werden, beispielsweise <b>bold</b> und <i>italic</i>, um Textattribute zu setzen. Sie werden direkt in die Dokumentation übernommen und müssen korrekt geschachtelt sein, damit die Ausgabe nicht falsch dargestellt wird. Die Überschriften-Tags <h1>..</h1> und <h2>..</h2> sollten jedoch nicht verwendet werden. JavaDoc verwendet sie zur Gliederung der Ausgabe und weist ihnen Formatvorlagen zu.

6.14.4 Generierte Dateien

Für jede öffentliche Klasse erstellt JavaDoc eine HTML-Datei. Sind Klassen nicht öffentlich, muss ein Schalter angegeben werden. Die HTML-Dateien werden zusätzlich mit Querverweisen zu den anderen dokumentierten Klassen versehen. Daneben erstellt JavaDoc weitere Dateien:

• index-all.html. Die Übersicht aller Klassen, Schnittstellen, Ausnahmen, Methoden und Felder in einem Index

• overview-tree.html. Zeigt in einer Baumstruktur die Klassen an, damit die Vererbung deutlich sichtbar ist.

• allclasses-frame.html. Anzeige aller dokumentierten Klassen in allen Unterpaketen

• deprecated-list.html. Liste der veralteten Methoden und Klassen

• serialized-form.html. Listet alle Klassen auf, die Serializable implementieren. Jedes Attribut erscheint mit einer Beschreibung in einem Absatz.

• help-doc.html. Eine Kurzbeschreibung von JavaDoc

• index.html. JavaDoc erzeugt eine Ansicht mit Frames. Das ist die Hauptdatei, die die rechte und linke Seite referenziert. Die linke Seite ist die Datei allclasses-frame.html. Rechts im Frame wird bei fehlender Paketbeschreibung die erste Klasse angezeigt.

• stylesheet.css. Formatvorlage für HTML-Dateien, in der sich Farben und Zeichensätze einstellen lassen, die dann alle HTML-Dateien nutzen.

• packages.htm. Eine veraltete Datei. Sie verweist auf die neuen Dateien.

6.14.5 Dokumentationskommentare im Überblick

JavaDoc-Kommentare kann der Entwickler in den Block setzen, so wie @param oder @return zur Beschreibung der Parameter oder Rückgaben, andere auch in den Text, wie {@link} zum Setzen eines Verweises auf einen anderen Typ oder Methode. Tags der ersten Gruppe heißen Block-Tags, die anderen Inline-Tags. Bisher erkennt das JavaDoc-Tool die folgenden Tags (ab welcher Version, steht in Klammern): [http://tutego.de/go/javadoctags ]

• Block-Tags: @author (1.0), @deprecated (1.0), @exception (1.0), @param (1.0), @return (1.0), @see (1.0), @serial (1.2), @serialData (1.2), @serialField (1.2), @since (1.1), @throws (1.2), @version (1.0)

• Inline-Tags: {@code} (1.5), {@docRoot} 1.3, {@inheritDoc} (1.4), {@link} 1.2, {@linkplain} 1.4, {@literal} (1.5), {@value} (1.4)

In Java 6 ist kein Tag hinzugekommen. Es gibt aber einiges auf der Liste, [http://tutego.de/go/proposedtags ] was als JavaDoc-Tag in Java 7 hinzukommen soll.

Beispiele

Eine externe Zusatzquelle geben wir wie folgt an:

@see <a href="spec.html#section">Java Spec</a>.

Verweis auf eine Funktion, die mit der beschriebenen Funktion verwandt ist:

@see String#equals(Object) equals

Von @see gibt es mehrere Varianten:

@see #field 
@see #method(Type, Type,...) 
@see #method(Type argname, Type argname,...) 
@see #constructor(Type, Type,...) 
@see #constructor(Type argname, Type argname,...) 
@see Class#field 
@see Class#method(Type, Type,...) 
@see Class#method(Type argname, Type argname,...) 
@see Class#constructor(Type, Type,...) 
@see Class#constructor(Type argname, Type argname,...) 
@see Class.NestedClass 
@see Class 
@see package.Class#field 
@see package.Class#method(Type, Type,...) 
@see package.Class#method(Type argname, Type argname,...) 
@see package.Class#constructor(Type, Type,...) 
@see package.Class#constructor(Type argname, Type argname,...) 
@see package.Class.NestedClass 
@see package.Class 
@see package

Dokumentiere eine Variable. Gib einen Verweis auf eine Methode an:

/** 
 * The X-coordinate of the component. 
 * 
 * @see #getLocation() 
 */ 
int x = 1263732;

Eine veraltete Methode, die auf eine Alternative zeigt:

/** 
 * @deprecated  As of JDK 1.1, 
 * replaced by {@link #setBounds(int,int,int,int)} 
 */

Statt HTML-Tags wie <tt> oder <code> für den Quellcode zu nutzen, ist {@code} da viel einfacher.

/** 
 * Compares this current object with another object. 
 * Uses {@code equals()} an not {@code ==}. 
 */

6.14.6 JavaDoc und Doclets

Die Ausgabe von JavaDoc kann den eigenen Bedürfnissen angepasst werden, indem Doclets eingesetzt werden. Ein Doclet ist ein Java-Programm, das auf der Doclet-API aufbaut und die Ausgabedatei schreibt. Das Programm liest dabei wie das bekannte JavaDoc-Tool die Quelldateien ein und erzeugt daraus ein beliebiges Ausgabeformat. Dieses Format kann selbst gewählt und implementiert werden. Wer also neben dem von JavaSoft beigefügten Standard-Doclet für HTML-Dateien Framemaker-Dateien (MIF) oder RTF-Dateien erzeugen möchte, muss ein eigenes Doclet programmieren oder kann auf Doclets unterschiedlicher Hersteller zurückgreifen. Die Webseite http://www.doclet.com/ listet zum Beispiel Doclets auf, die Docbook generieren oder UML-Diagramme mit aufnehmen.

Daneben dient ein Doclet aber nicht nur der Schnittstellendokumentation. Ein Doclet kann auch aufzeigen, ob es zu jeder Methode eine Dokumentation gibt oder ob jeder Parameter und jeder Rückgabewert korrekt beschrieben ist. Vor dem Durchbruch der Annotationen in Java 5 waren Doclets zur Generierung zusätzlicher Programmdateien und XML-Deskriptoren populär. [XDoclet (http://xdoclet.sourceforge.net/) generiert aus Anmerkungen in den JavaDoc-Tags Mappings-Dateien für relationale Datenbanken oder Dokumente für Enterprise Java Beans. ]

6.14.7 Veraltete (deprecated) Klassen, Konstruktoren und Methoden

Während der Entwicklungsphase einer Software ändern sich immer wieder Methodensignaturen, oder Methoden kommen hinzu oder fallen weg. Gründe gibt es viele:

• Methoden können nicht wirklich plattformunabhängig programmiert werden, wurden aber einmal so angeboten. Nun soll die Methode nicht mehr unterstützt werden. (Ein Beispiel ist die Methode stop() eines Threads.)

• Die Java-Namenskonvention soll eingeführt, ältere Methodennamen sollen nicht mehr verwendet werden. Das betrifft in erster Linie spezielle setXXX()/getXXX()-Methoden, die seit Version 1.1 eingeführt wurden. So finden wir beim AWT viele Beispiele dafür. Nun heißt es zum Beispiel statt size() bei einer grafischen Komponente getSize().

• Entwickler haben sich beim Methodennamen verschrieben. So hieß es in FontMetrics vorher getMaxDecent() und nun getMaxDescent(), und im HTMLEditorKit wird insertAtBoundry() zu insertAtBoundary().

Es ist ungünstig, die Methoden jetzt einfach zu löschen, weil es dann zu Compilerfehlern kommt. Eine Lösung wäre daher, die Methode beziehungsweise den Konstruktor deprecated zu deklarieren. Deprecated ist ein eigener Dokumentationskommentar; das sieht dann etwa folgendermaßen aus (Ausschnitt aus der Klasse java.util.Date):

/** 
 * Sets the day of the month of this <tt>Date</tt> object to the 
 * specified value. ... 
 * 
 * @param   date   the day of the month value between 1–31. 
 * @see     java.util.Calendar 
 * @deprecated As of JDK version 1.1, 
 * replaced by <code>Calendar.set(Calendar.DAY_OF_MONTH, int date)</code>. 
 */ 
 
public void setDate(int date) { 
  setField(Calendar.DATE, date); 
}

Die Kennung @deprecated gibt an, dass die Methode/der Konstruktor nicht mehr verwendet werden soll. Ein guter Kommentar gibt auch Alternativen an, sofern welche vorhanden sind. Die hier genannte Alternative ist die Methode set() aus dem Calendar-Objekt. Da der Kommentar in die generierte API-Dokumentation übernommen wird, erkennt der Entwickler, dass eine Methode veraltet ist.

Compilermeldungen bei veralteten Methoden

Der Compiler gibt bei veralteten Methoden eine kleine Meldung auf dem Bildschirm aus. Testen wir das an der Klasse OldSack:

Listing 6.113 OldSack.java

public class OldSack 
{ 
  java.util.Date d = new java.util.Date( 62, 3, 4 ); 
}

Jetzt rufen wir ganz normal den Compiler auf.

$ javac OldSack.java 
Note: OldSack.java uses or overrides a deprecated API. 
Note: Recompile with -deprecation for details.

Der Compiler sagt uns, dass der Schalter -deprecation weitere Hinweise gibt.

$ javac -deprecation OldSack.java 
OldSack.java:5: warning: Date(int,int,int) in java.util.Date has been deprecated 
  Date d = new Date( 62, 3, 4 ); 
           ^ 
1 warning

Die Ausgabe gibt genau die Zeile mit der veralteten Anweisung an; Alternativen nennt er nicht. Allerdings ist schon interessant, dass der Compiler in die Dokumentationskommentare sieht. Eigentlich hat er mit den auskommentierten Blöcken nichts zu tun und überliest jeden Kommentar. Zur Auswertung der speziellen Kommentare gibt es ja das Extra-Tool javadoc, das wiederum mit dem Java-Compiler nichts zu tun hat.

Die Annotation @Deprecated

Seit Java 5 gibt es Annotationen, die zusätzliche Modifizierer sind. Eine Annotation @Deprecated (groß geschrieben) ist vorgegeben und ermöglicht es ebenfalls, Dinge als veraltet zu kennzeichnen. Dazu wird die Annotation wie ein üblicher Modifizierer etwa für Methoden vor den Rückgabetyp gestellt. Sun hat die oben genannte Funktion setDate() mit dieser Annotation gekennzeichnet, wie der folgende Ausschnitt zeigt:

/** ... 
 * @deprecated As of JDK version 1.1, 
 * replaced by <code>Calendar.set(Calendar.DAY_OF_MONTH, int date)</code>. 
 */ 
@Deprecated 
public void setDate(int date) { ... }

Der Vorteil der Annotation @Deprecated gegenüber dem JavaDoc-Tag besteht darin, dass die Annotation auch zur Laufzeit sichtbar ist. Liegt vor einem Methodenaufruf ein @Deprecated-Tester, so kann dieser die veralteten Methoden zur Laufzeit melden. Bei dem JavaDoc-Tag übersetzt der Compiler das Programm in Bytecode und gibt zur Compilerzeit eine Meldung aus, im Bytecode selbst gibt es aber keinen Hinweis.

Ihr Kommentar