home  |  suche  |  kontakt/johner  |  institut 
studierende  |  tech-docs  |  mindmailer 

JavaDocs

Javadoc ist ein Programm, das aus Java-Quelltexten Dokumentationen im HTML-Format erstellt. Die Dokumentation besteht dabei aus den öffentlichen Klassen-, Interface- und Methodendeklarationen und eventuell zusätzlichen Dokumentationskommentaren. Ein Dokumentationskommentar beginnt mit /** und endet mit */ und muss im Quelltest immer unmittelbar vor dem zu dokumentierenden Item (Klassendefiniton, Methode...) platziert werden. Dieser Kommentar darf neben normalem Text auch HTML-Tags enthalten. Außerdem erkennt javadoc markierte Absätze, die mit dem @-Zeichen eingeleitet werden. Die Markierung leitet einen neuen Absatz ein und haben einen vordefinierten Wert. Zum Beispiel wird die Markierung @param beim generieren als Parameters: übersetzt. Javadocs wird im JDK mitgeliefert.

 

package javadoc;

/**
* Diese Klasse dient der Dokumentation.
* Benutzen Sie <b>nicht</b>
* <ul>
* <li>Frames, iFrames</li>
* <li>Headings h1, h2, ..</li>
* </ul>
* <p>Hingegen können Sie benutzen</p>
* <ol>
* <li>Fett a</li>
* <li>Listen</li>
* <li>Kursiv i</li>
* <li>Formatiert code, pre</li>
* <li>Tabellen table</li>
* </ol>
*
* @author cjohner
*
*/
public class StartJavaDoc {
public static void main(String[] args) {

}

/**
* Diese Methode berechnet den Jahreszins
*
* @param name der Name des Kunden
* @param betrag der Betrag in Euro
* @param Person der Kreditgeber
* @return der berechnete Jahreszins
*
* @throws Exception
*/
public int doSth(String name, double betrag, Person person) throws Exception {
//hier kommt eine Berechnung
return 0;
}

}

Bei der Generierung der Dokumentation im HTML-Format wird für jede Klasse eine HTML-Seite generiert, die den gleichen Namen trägt wie die Klasse selbst. In Eclipse kann man sich einfach über File-->Export-->Javadoc die Seiten vom JavaCompiler erzeugen lassen. In der Konsole erfolgt der Aufruf mit dem Befehl javadoc. Für das Beispiel würde die erzeugte Seite so aussehen.