23.4    Dokumentationskommentare mit Javadoc 

Die Dokumentation von Softwaresystemen ist ein wichtiger, aber oft vernachlässigter Teil der Softwareentwicklung. Leider, denn Software wird im Allgemeinen öfter gelesen als geschrieben. Während des Entwicklungsprozesses 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 Wiederverwendung zur Verfügung stellen. Um die Klassen, Schnittstellen, Aufzählungen und Methoden sowie Attribute gut zu verstehen, müssen sie sorgfältig beschrieben werden. Wichtig bei der Beschreibung sind der Typname, der Methodenname, die Art und die Anzahl der Parameter, die Wirkung der Methoden 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.[ 290 ](Die Idee ist nicht neu. In den 1980er-Jahren 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. )

 

23.4.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, für Attribute und Methoden an:

Listing 23.1    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;

  }

}

Tabelle 23.4    Die wichtigsten Dokumentationskommentare im Überblick

/**

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

 

23.4.2    Mit dem Werkzeug javadoc eine Dokumentation erstellen 

Aus dem mit Kommentaren versehenen Quellcode generiert ein externes Programm die Zieldokumente. Das JDK liefert das Konsolenprogramm javadoc mit aus, 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 in dem 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 eine HTML-Seite ist.

  In Eclipse lässt sich eine Dokumentation mit Javadoc sehr einfach erstellen: Im Menü File • Export ist der Eintrag Javadoc zu wählen, und nach einigen Einstellungen ist die Dokumentation generiert.

 

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

  In Eclipse zeigt die Ansicht javadoc in einer Vorschau das Ergebnis des Dokumentationskommentars an.

 

23.4.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 liefert eine Ü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 zeigt alle dokumentierten Klassen in allen Unterpaketen auf.

• deprecated-list.html bietet eine 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 zeigt 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 ist eine Formatvorlage für HTML-Dateien, in der sich unter anderem Farben und Schriftarten einstellen lassen, die dann alle HTML-Dateien nutzen.

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

 

23.4.5    Dokumentationskommentare im Überblick * 

Einige Javadoc-Kommentare müssen isoliert hinter der Hauptbeschreibung folgen, wie @param (Beschreibung der Parameter) oder @return (Beschreibung der Rückgaben). Sie heißen Block-Tags. Andere Tags können im Text auftauchen, wie {@link} zum Setzen eines Verweises auf einen anderen Typ oder eine andere Methode. Wir nennen sie Inline-Tags. Das Javadoc-Tool erkennt unter anderem die folgenden Tags:

• Block-Tags: @apiNote, @author, @deprecated, @exception, @implNote, @implSpec, @param, @return, @see, @serial, @serialData, @serialField, @since, @throws, @version

• Inline-Tags: {@code}, {@docRoot}, {@inheritDoc}, {@link}, {@linkplain},
  
  {@literal}, {@value}

Beispiele

Eine externe Zusatzquelle geben wir wie folgt an:

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

So verweisen wir auf eine Methode, die mit der beschriebenen Methode 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)}

 */

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

/**

 * Compares this current object with another object.

 * Uses {@code equals()} an not {@code ==}.

 */

In den letzten Java-Versionen sind neue Tags hinzugekommen:

• Eingeführt in Java 9: @index, @hidden, @provides, @uses

• Eingeführt in Java 10: @summary

 

23.4.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, der muss ein eigenes Doclet programmieren oder kann auf Doclets unterschiedlicher Hersteller zurückgreifen. Die (schon etwas angestaubte) Website 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 wurde.

 

23.4.7    Veraltete (deprecated) Typen und Eigenschaften 

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 werden und ältere Methodennamen sollen nicht mehr verwendet werden. Das betrifft in erster Linie spezielle setXXX(…)/getXXX()-Methoden, die ab Version 1.1 zur Verfügung standen. 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 heißt es 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 oder den Konstruktor als deprecated zu deklarieren. @deprecated ist ein eigener Dokumentationskommentar. Sein Einsatz sieht dann etwa folgendermaßen aus (Ausschnitt aus der Klasse java.util.Date):

Listing 23.2    java.util.Date.java, Ausschnitt

/**

 * 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 bzw. der Konstruktor nicht mehr verwendet werden soll. Ein guter Kommentar zeigt auch Alternativen auf, 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 23.3    src/main/java/com/tutego/insel/tools/OldSack.java

package com.tutego.insel.tool;



//@SuppressWarnings( "deprecation" )

public class OldSack {

  java.util.Date d = new java.util.Date( 62, 3, 4 );

}

Jetzt rufen wir ganz normal den Compiler auf:

$ javac com/tutego/insel/tool/OldSack.java

Note: com\tutego\insel\tool\OldSack.java uses or overrides a deprecated API.

Note: Recompile with -Xlint:deprecation for details.

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

$ javac -deprecation com.tutego.insel.tool.OldSack.java

com\tutego\insel\tool\OldSack.java:5: warning: [deprecation] Date(int,int,int) in Date has been deprecated

  java.util.Date d = new java.util.Date( 62, 3, 4 );

                     ^

1 warning

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

Die Annotation @Deprecated

Annotationen sind eine Art zusätzlicher Modifizierer. Die 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. Oracle hat die oben genannte Methode 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 Compilezeit eine Meldung aus, im Bytecode selbst gibt es aber keinen Hinweis.

In Java 9 wurde der Annotationstyp @Deprecated um zwei Eigenschaften erweitert:

• String since() default "": Dokumentiert die Version, seit der das Element veraltet ist.

• boolean forRemoval() default false: Zeigt an, dass das Element in Zukunft gelöscht werden soll.

@Deprecated(since="1.2", forRemoval=true)

public final synchronized void stop(Throwable obj) {

  throw new UnsupportedOperationException();

}

 

23.4.8    Javadoc-Überprüfung mit DocLint 

Das Javadoc-Tool kann in den Javadoc-Kommentaren Fehler aufspüren; aktiviert wird diese Prüfung mit dem Schalter Xdoclint. DocLint erkennt folgende Gruppen von Fehlern, die auch als Option angegeben werden können:

Tabelle 23.5    Mögliche Gruppen bei Javadoc und dem DocLint-Werkzeug

Zu weiteren Optionen der Javadoc-Erweiterung siehe http://docs.oracle.com/en/java/javase/14/docs/specs/man/javadoc.html.