Javadoc - LinkFang.de





Javadoc


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

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.

Funktionsweise

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

  1. /**
  2.  * Ein Hello-World-Programm in Java.
  3.  * Dies ist ein Javadoc-Kommentar.
  4.  *
  5.  * @author John Doe
  6.  * @version 1.0
  7.  */
  8. public class Hello {
  9.     /**
  10.      * Hauptprogramm.
  11.      *
  12.      * @param args Kommandozeilenparameter
  13.      */
  14.     public static void main(String[] args) {
  15.         System.out.println("Hallo Welt!");
  16.     }
  17. }

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.

Übersicht der Javadoc-Tags

Tag und Parameter Ausgabe Verwendung in seit
@author name Beschreibt den Autor. Klasse, Interface
@version version Erzeugt einen Versionseintrag. Maximal einmal pro Klasse oder Interface. Klasse, Interface
@since jdk-version Seit wann die Funktionalität existiert. Klasse, Interface, Instanzvariable, Methode
@see reference Erzeugt einen Link auf ein anderes Element der Dokumentation. Klasse, Interface, Instanzvariable, Methode
@serial Bei einem Serializable Objekt beschreibt es die serialisierten Daten des Objekts. Klasse
@serialField Dokumentiert ein Feld von einem Serializable Objekt. Klasse, Methode
@param name description Parameterbeschreibung einer Methode. Methode
@return description Beschreibung des Rückgabewerts einer Methode. Methode
@exception classname description
@throws classname description
Beschreibung einer Exception, die von dieser Methode geworfen werden kann. Methode
@deprecated description Beschreibt eine veraltete Methode, die nicht mehr verwendet werden sollte. Sollte ab Java 5.0 immer mit der @Deprecated-Annotation verwendet werden. Methode
{@inheritDoc} Kopiert die Beschreibung aus der überschriebenen Methode. Überschreibende Methode 1.4.0
{@link reference} Link zu einem anderen Symbol. Klasse, Interface, Instanzvariable, Methode
{@linkPlain reference} Der Link wird in Standardtext statt in Quelltextzeichensatz angezeigt. Klasse, Interface, Instanzvariable, Methode 1.4.0
{@value} Gibt den Wert eines konstanten Feldes zurück. Statisches Feld 1.4.0
{@docRoot} Gibt den absoluten Pfad zum Hauptverzeichnis wieder. Package, Klassen, Felder, Methoden
{@code} Formatiert Text buchstabengetreu mit dem Quelltextzeichensatz (entsprechend <code>) und unterdrückt die Interpretierung von beinhalteten HTML oder Javadoc-Tags. Klasse, Interface, Instanzvariable, Methode 5.0
{@literal} Kennzeichnet buchstabengetreuen Text und unterdrückt die Interpretierung von beinhalteten HTML oder Javadoc-Tags. Klasse, Interface, Instanzvariable, Methode 5.0

Um das Symbol „@“ zu verwenden, ohne ein Javadoc-Tag zu beginnen, kann der HTML-Zeichen-Code „&#064;“ 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.

Ähnliche Werkzeuge

Weblinks


Kategorien: Java (Programmiersprache) | Freies Programmierwerkzeug

Quelle: Wikipedia - http://de.wikipedia.org/wiki/Javadoc (Vollständige Liste der Autoren des Textes [Versionsgeschichte])    Lizenz: CC-by-sa-3.0

Änderungen: Alle Bilder mit den meisten Bildunterschriften wurden entfernt. Ebenso alle zu nicht-existierenden Artikeln/Kategorien gehenden internen Wikipedia-Links (Bsp. Portal-Links, Redlinks, Bearbeiten-Links). Entfernung von Navigationsframes, Geo & Normdaten, Mediadateien, gesprochene Versionen, z.T. ID&Class-Namen, Style von Div-Containern, Metadaten, Vorlagen, wie lesenwerte Artikel. Ansonsten sind keine Inhaltsänderungen vorgenommen worden. Weiterhin kann es durch die maschinelle Bearbeitung des Inhalts zu Fehlern gerade in der Darstellung kommen. Darum würden wir jeden Besucher unserer Seite darum bitten uns diese Fehler über den Support mittels einer Nachricht mit Link zu melden. Vielen Dank!

Stand der Informationen: August 201& - Wichtiger Hinweis: Da die Inhalte maschinell von Wikipedia übernommen wurden, ist eine manuelle Überprüfung nicht möglich. Somit garantiert LinkFang.de nicht die Richtigkeit und Aktualität der übernommenen Inhalte. Sollten die Informationen mittlerweile fehlerhaft sein, bitten wir Sie darum uns per Support oder E-Mail zu kontaktieren. Wir werden uns dann innerhalb von spätestens 10 Tagen um Ihr Anliegen kümmern. Auch ohne Anliegen erfolgt mindestens alle drei Monate ein Update der gesamten Inhalte.