Top-Fragen
Zeitleiste
Chat
Kontext

Javadoc

Programmdokumentationswerkzeug Aus Wikipedia, der freien Enzyklopädie

Remove ads

Javadoc ist ein Software-Dokumentationswerkzeug, das aus Java-Quelltexten automatisch HTML-Dokumentationsdateien erstellt. Javadoc wurde ebenso wie Java von Sun Microsystems entwickelt und ist ab Version 2 ein Bestandteil des Java Development Kits.

Thumb

Die Dokumentation kann durch spezielle Kommentare im Quelltext angereichert werden, hierbei kommen Tags zum Einsatz, die dazu dienen, z. B. Interfaces, Klassen, Methoden und Felder näher zu beschreiben. Neben der Standardausgabe in HTML sind alternative Ausgaben durch spezielle Doclets möglich. Dies ist eine einfache Form des Literate programming.

Remove ads

Funktionsweise

Zusammenfassung
Kontext

Javadoc erhält beim Aufruf Optionen mit Angaben über die zu dokumentierenden Java-Quelltexte. Javadoc parst die Quelltexte nach allen Javadoc-Kommentaren (beginnend mit /**) und den darauf folgenden, nicht-lokalen Symbolen. Jeder Javadoc-Kommentar wird nach darin enthaltenen Javadoc-Tags (beginnend mit @ oder {@) gescannt. Diese enthalten Metadaten mit dokumentativem Charakter über das jeweilige Symbol. Mit Hilfe sogenannter Taglets kann der bestehende Tag-Wortschatz von Javadoc erweitert werden. Das Doclet erzeugt anschließend die Ausgabe. Das Standard-Doclet erzeugt eine Ausgabe in HTML. Es existieren aber auch weitere Doclets, um die Dokumentation in anderen Formaten wie RTF, XML, PDF, FrameMaker, Windows Help und einigen mehr zu erzeugen.

Beispiel-Quelltext

/**
 * Ein Hello-World-Programm in Java.
 * Dies ist ein Javadoc-Kommentar.
 *
 * @author John Doe
 * @version 1.0
 */
public class Hello {
    /**
     * Hauptprogramm.
     *
     * @param args Kommandozeilenparameter
     */
    public static void main(String[] args) {
        System.out.println("Hallo Welt!");
    }
}

Beispiel-Ausgabe

Ein Beispiel für die Ausgabe von Javadoc ist die Java-API-Dokumentation von Oracle (siehe Weblinks), die mit Hilfe von Javadoc erstellt wurde.

Remove ads

Übersicht der Javadoc-Tags

Zusammenfassung
Kontext
Weitere Informationen Tag und Parameter, Ausgabe ...

Um das Symbol „@“ zu verwenden, ohne ein Javadoc-Tag zu beginnen, kann der HTML-Zeichen-Code „@“ verwendet werden. Dies ist beispielsweise nützlich, um in einem Code-Beispiel innerhalb eines Javadoc-Kommentars Annotationen zu verwenden, die wie ein Javadoc-Tag mit einem „@“ beginnen.

Remove ads

Ähnliche Werkzeuge

Loading related searches...

Wikiwand - on

Seamless Wikipedia browsing. On steroids.

Remove ads