JavaDoc
Kommentare können dabei für Interfaces, Klassen, Methoden und Felder über spezielle Doclet-Tags definiert werden. JavaDoc wurde ebenso wie Java von Sun Microsystems entwickelt und ist Bestandteil des Java 2 Software Development Kits (J2SDK).
Nach dem Vorbild JavaDocs entwickelte Microsoft XmlDoc für seine .NET-Plattform.
| Inhaltsverzeichnis |
|
2 Funktionsweise 3 Siehe auch 4 Weblinks |
Anwendungsgebiet
Java ist eine objektorientierte Programmiersprache. Die Kapselung und das Geheimnisprinzip werden als zentrale Elemente objektorientierten Programmierens angesehen, insbesondere in Java. Daraus folgt, dass zur Verwendung eines Symbols, z.B. einer Klasse oder einer Methode, seine öffentliche Schnittstelle und seine Spezifikation herangezogen werden sollten. Sich vor der Verwendung Kenntnisse über die interne Funktionsweise zu verschaffen, verstößt gegen das Geheimnisprinzip und macht außerdem unter Umständen von Änderungen in der Implementierung abhängig. Daher ist es notwendig, die Schnittstelle zu spezifizieren und dokumentieren. Das ist das Haupteinsatzgebiet von Javadoc.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
/** Ein Hello-World-Programm in Java.
* Dies ist ein JavaDoc-Kommentar.
* @author John Doe
* @version 1.0
*/
public final class Hello {
/** Hauptprogramm.
* @param args Kommandozeilenparameter (derzeit ignoriert)
*/
public static final void main(final String... args) {
System.out.println("Hallo, Welt!");
}
} // class Hello
Beispiel-Ausgabe
Auch die Java-API-Dokumentation wurde mit Hilfe von JavaDoc erstellt. Sie ist meist die erste JavaDoc-Dokumentation, mit der ein Java-Programmierer konfrontiert wird. Sie ist zu finden unter [1].Siehe auch
- Doxygen, ein Dokumentationswerkzeug für diverse Programmiersprachen, auch Java
Weblinks
- JavaDoc Homepage (engl.)
- Javadoc und Doclets (Vortrag)
