Weitere aktuelle Java-Titel finden Sie bei dpunkt.
 Inhaltsverzeichnis   Auf Ebene Zurück   Seite Zurück   Seite Vor   Auf Ebene Vor   Eine Ebene höher   Index


B.6

javadoc


javadoc ist ein Dokumentationsgenerator. Er erzeugt anhand von Java-Quelltexten eine Dokumentation, in der die jeweiligen Klassen, Interfaces, Methoden, Konstruktoren und Datenelemente aufgeführt sind.

Als Argument bekommt javadoc einen Paketnamen oder die Namen von Java-Quelltexten übergeben. Auch die bei javac beschriebene @-Syntax zum Einlesen von Listen wird unterstützt.

Seit [1.2]Version 1.2 ist es möglich, die Dokumentation mit selbstdefinierten Klassen, den so genannten Doclets, zu generieren. Hierbei analysiert javadoc die zu dokumentierenden Klassen und macht dem Doclet die ermittelten Informationen über das API des Pakets com.sun.javadoc zugänglich. Auf diese Weise kann sich die Implementierung der Doclets auf die äußerliche Darstellung der Dokumentation konzentrieren. javadoc beinhaltet ein Standard-Doclet, das eine HTML-Dokumentation erzeugt.

Doclets können eigene Optionen haben. Daher gibt es sowohl Optionen von javadoc selbst, die immer verfügbar sind, als auch Doclet-abhängige Optionen. Nachfolgend sind zunächst die Optionen von javadoc aufgeführt, gefolgt von den Optionen des Standard-Doclets.

javadoc besitzt folgende Optionen: Das mitgelieferte Standard-Doclet, das die Formatierung der Dokumentation übernimmt, stellt zusätzlich folgende Optionen zur Verfügung: Innerhalb von Kommentaren in Quelltexten kann man spezielle Anweisungen für javadoc einfügen, die so genannten javadoc-Tags. Durch diese Tags kann man zusätzliche Informationen in die erzeugte Dokumentation einbringen und Querverweise zwischen Methoden einbinden. Die Tags beginnen alle mit dem Zeichen @. Im Folgenden werden die wichtigsten Tags aufgeführt. Zur Dokumentation von Klassen können folgende Tags verwendet werden: Mit folgenden Tags können Methoden dokumentiert werden: Bei Datenelementen kann zusätzlich zu den Tags @see, @since und @deprecated das Tag @value verwendet werden, das den Wert von konstanten Datenelementen anzeigt. An jeder Stelle können die folgenden Tags zur Erzeugung von Verweisen verwendet werden:


 Inhaltsverzeichnis   Auf Ebene Zurück   Seite Zurück   Seite Vor   Auf Ebene Vor   Eine Ebene höher   Index

Copyright © 2002 dpunkt.Verlag, Heidelberg. Alle Rechte vorbehalten.