Dokumentation von Programmen (javadoc)

copyleft: munz
Dokumentation von Programmen (javadoc)
Dokumentation von Programmen (javadoc)
Mit dem Hilfsprogramm javadoc, das Teil des JDK ist, kann eine Dokumentation der Java-Programme im
HTML-Format erzeugt werden, so wie die Online-Dokumentation (API) der Klassenbibliothek.
Der Aufruf von
javadoc Xxxx.java
für einzelne Source-Programme oder
javadoc *.java
für alle Java-Programme im aktuellen Directory erzeugt für jedes SourceProgramm ein Dokumentations-File Xxxx.html sowie (bis JDK 1.1) einen PackageIndex packages.html, einen Klassen-Index tree.html und einen Namens-Index
AllNames.html bzw. ab JDK 1.2 eine größere Anzahl von solchen HTML-Files, die
von einem Start-File index.html ausgehen. Vorsicht, bereits existierende
gleichnamige Dateien werden dabei überschrieben.
Javadoc extrahiert automatisch alle public und protected Deklarationen von Klassen, Datenfeldern,
Konstruktoren und Methoden. Zusätzliche Informationen kann man in Form von speziellen Kommentaren
hinzufügen, die jeweils in
/** ... */
eingeschlossen werden, vor der jeweiligen Deklaration stehen und einfachen HTML-Text enthalten.
Beispiel:
/**
* ein einfaches Hello-World-Programm.
* <p>
* Im Gegensatz zum kurzen, rein statischen "HelloWorld"
* ist dieses Programm ein Musterbeispiel
* für eine <b>objekt-orientierte</b> Java-Applikation.
*
* @author copyleft munz
* @version 99.9
* @since JDK 1.0
* @see HelloWorld
*/
public class HelloDoc {
/** der Text, der gedruckt werden soll.
*/
public String messageText = "Hello World!";
/** druckt den Text messageText auf System.out aus.
* @see #messageText
*/
public void printText() {
System.out.println (messageText);
}
/** Test des HelloDoc-Objekts.
*/
public static void main (String[] args) {
HelloDoc h = new HelloDoc();
h.printText();
}
}
D:\257769006.doc
Mit Eclipse s. folgende Seiten.
1
copyleft: munz
Dokumentation von Programmen (javadoc)
1. Exportieren
D:\257769006.doc
2
copyleft: munz
Dokumentation von Programmen (javadoc)
2. JAVA – javadoc
3. Pfad eingeben
D:\257769006.doc
3
copyleft: munz
Dokumentation von Programmen (javadoc)
4. Im Dateisystem findet man unter Eclipse – Workspace – Hallo – Doc die fertige professionelle Doku.
D:\257769006.doc
4