imported>Invisigoth67: Änderungen von 85.16.67.77 (Diskussion) auf die letzte Version von Invisigoth67 zurückgesetzt

2025-01-16T09:18:00Z

Änderungen von 85.16.67.77 (Diskussion) auf die letzte Version von Invisigoth67 zurückgesetzt

Neue Seite

[[Datei:Javadoc screenshot.png|miniatur|]]

'''Javadoc''' ist ein [[Software-Dokumentationswerkzeug]], das aus [[Java (Programmiersprache)|Java]]-[[Quellcode|Quelltexten]] automatisch [[Hypertext Markup Language|HTML]]-Dokumentationsdateien erstellt. Javadoc wurde ebenso wie Java von [[Sun Microsystems]] entwickelt und ist ab Version 2 ein Bestandteil des ''[[Java Development Kit]]s''.

Die Dokumentation kann durch spezielle [[Kommentar (Programmierung)|Kommentare]] im Quelltext angereichert werden, hierbei kommen [[Tag (Informatik)|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 [[Doclet]]s möglich. Dies ist eine einfache Form des [[Literate programming]].

== Funktionsweise ==
Javadoc erhält beim Aufruf Optionen mit Angaben über die zu dokumentierenden Java-Quelltexte. Javadoc [[Parser|parst]] die Quelltexte nach allen Javadoc-Kommentaren (beginnend mit <code>/**</code>) und den darauf folgenden, nicht-lokalen Symbolen. Jeder Javadoc-Kommentar wird nach darin enthaltenen Javadoc-Tags (beginnend mit <code>@</code> oder <code>{@</code>) 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 [[Rich Text Format|RTF]], [[Extensible Markup Language|XML]], [[Portable Document Format|PDF]], [[FrameMaker]], [[Microsoft Help|Windows Help]] und einigen mehr zu erzeugen.

=== Beispiel-Quelltext ===
<syntaxhighlight line highlight="5-6,12" lang="java">
/**
* 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!");
}
}
</syntaxhighlight>

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

== Übersicht der Javadoc-Tags ==
{| class="wikitable"
! Tag und Parameter
! Ausgabe
! Verwendung in
! seit
|-
|<code>@author</code> name|| Beschreibt den Autor. || Klasse, Interface ||
|-
|<code>@version</code> version|| Erzeugt einen Versionseintrag. Maximal einmal pro Klasse oder Interface. Bei Verwendung eines [[Versionsverwaltung]]ssystems wie z. B. [[Concurrent Versions System|CVS]] kann durch Verwendung eines von dessen Schlüsselwörtern der Eintrag automatisch aktuell gehalten werden: <code>@version $Revision$</code> || Klasse, Interface ||
|-
|<code>@since</code> jdk-version|| Seit wann die Funktionalität existiert. || Klasse, Interface, Instanzvariable, Methode ||
|-
|<code>@see</code> reference|| Erzeugt einen Link auf ein anderes Element der Dokumentation. || Klasse, Interface, Instanzvariable, Methode ||
|-
|<code>@serial</code> || Beschreibt die serialisierten Daten eines <code>Serializable</code>-Objekts. || Klasse ||
|-
|<code>@serialField</code>|| Dokumentiert ein Feld eines <code>Serializable</code>-Objekts. || Klasse, Methode ||
|-
|<code>@param</code> name description|| Parameterbeschreibung einer Methode. || Methode ||
|-
|<code>@return</code> description|| Beschreibung des Rückgabewerts einer Methode. || Methode||
|-
|<code>@exception</code> classname description<br /><code>@throws</code> classname description|| Beschreibung einer Exception, die von dieser Methode geworfen werden kann.|| Methode ||
|-
|<code>@deprecated</code> description|| Beschreibt eine veraltete Methode, die nicht mehr verwendet werden sollte. Sollte ab Java 5.0 immer mit der <code>@Deprecated</code>-Annotation verwendet werden.|| Methode ||
|-
|<code>{@inheritDoc}</code>||Kopiert die Beschreibung aus der überschriebenen Methode. ||Überschreibende Methode ||1.4.0
|-
|<code>{@link ''reference''}</code>||Link zu einem anderen Symbol.||Klasse, Interface, Instanzvariable, Methode ||
|-
|<code>{@linkPlain ''reference''}</code>|| Der Link wird in Standardtext statt in Quelltextzeichensatz angezeigt.||Klasse, Interface, Instanzvariable, Methode ||1.4.0
|-
|<code>{@value}</code>|| Gibt den Wert eines konstanten Feldes zurück. || Statisches Feld ||1.4.0
|-
|<code>{@docRoot}</code> || Gibt den absoluten Pfad zum Hauptverzeichnis wieder. || Package, Klassen, Felder, Methoden ||
|-
|<code>{@code}</code>|| Formatiert Text buchstabengetreu mit dem Quelltextzeichensatz (entsprechend <span style="font-family:monospace;"><code></span>) und unterdrückt die Interpretierung von beinhalteten HTML oder Javadoc-Tags.||Klasse, Interface, Instanzvariable, Methode ||5.0
|-
|<code>{@literal}</code>|| Kennzeichnet buchstabengetreuen Text und unterdrückt die Interpretierung von beinhalteten HTML oder Javadoc-Tags. ||Klasse, Interface, Instanzvariable, Methode ||5.0
|}
Um das Symbol „<code>[[@]]</code>“ zu verwenden, ohne ein Javadoc-Tag zu beginnen, kann der HTML-Zeichen-Code „<code>&#064;</code>“ verwendet werden. Dies ist beispielsweise nützlich, um in einem Code-Beispiel innerhalb eines Javadoc-Kommentars [[Annotation (Java)|Annotationen]] zu verwenden, die wie ein Javadoc-Tag mit einem „<code>@</code>“ beginnen.

== Ähnliche Werkzeuge ==
* [[Doxygen]]
* [[Natural Docs]]
* [[PhpDocumentor]]
* [[Sphinx (Software)|Sphinx]]

== Weblinks ==
* [https://www.oracle.com/java/technologies/javase/javadoc.html Javadoc Homepage] (englisch)
* [https://docs.oracle.com/javase/6/docs/api/ JavaTM 2 Platform Standard Edition 6.0: API Specification] – die mittels Javadoc erzeugte Original-Java-API-Dokumentation (englisch)

[[Kategorie:Java (Programmiersprache)]]
[[Kategorie:Freies Programmierwerkzeug]]

Javadoc - Versionsgeschichte

imported>Invisigoth67: Änderungen von 85.16.67.77 (Diskussion) auf die letzte Version von Invisigoth67 zurückgesetzt