Javadoc ist der de -facto-Standard für die Erzeugung von Quellcode -Dokumentation . Es ist ein Werkzeug, um HTML-Dokumentation aus speziell formatierten Kommentaren in Java-Code zu erstellen. Dies kann zur Erzeugung strukturierter Application Programming Interface (API) -Dokumentation automatisch , geben einige Hinweise auf die IDE oder für die Zuordnung von Paketen , Klassen und Methoden werden. Im Grunde ist es eine Möglichkeit zu kommentieren Parameterbeschreibungen ist , schrieb , was und wer ist schuld , wenn es bricht . Java kommt mit dem javadoc Kommandozeilen-Programm , um die HTML-Dokumentation zu erzeugen , aber die meisten Java integrierten Entwicklungsumgebungen ( IDEs ) haben auch diese integriert. Anleitung
1
Erstellen Sie spezielle javadoc Kommentare . Um einen Kommentar javadoc bezeichnen , starten Sie den Kommentar mit /** . Javadoc Kommentare Regel existieren an der Spitze einer Datei , bevor Klassen und Methoden vor . Da es für die vollständige API-Dokumentation konzipiert ist, ist es nicht ungewöhnlich, dass Dateien mit mehr als javadoc Kommentare Code zu sehen . "" /*** Dies ist ein Javadoc-Kommentar . Es hat keinen javadoc Meta-Tags noch nicht, aber es tat auslösen javadoc Parser , einen Blick auf diesen Kommentar zu nehmen. * /""
2
hinzufügen API Meta-Tags ( Schlagworte , die die API selbst zu beschreiben ), wenn kommentieren . API -Tags sind Parameter , Beschreibungen Ausnahme Profilen Rückgabewert Beschreibungen , Methode Namen und Verfahrensbeschreibungen . Viele IDEs integrieren diese Daten in ihren Tooltips und anderen Helfern , ebenso wie es für die Verwendung in HTML oder Kommentar-Formular .
3
Verwenden Sie die Methode Beschreibung. Diese Meta -Tag hat keinen Tag-Namen : Es ist einfach der Kommentar, der vor den anderen Tags kommt "" /*** Berechnet die Steigung einer Geraden . . * /""
4
Integrieren Parameterbeschreibungen . Diese werden durch die @ param Meta-Tags , die von einem Parameter-Namen und Beschreibung befolgt werden sollten bezeichnet. "" /*** Berechnet die Steigung einer Geraden . ** @ Param p1 Erster Punkt , die die Zeile beschreibt * @ param p2 Zweiter Punkt , der die Zeile * /""
5
Rückgabewert Beschreibungen beschreibt . Dies wird durch die @ return Meta-Tag bezeichnet und sollte durch eine Beschreibung des Rückgabewerts befolgt werden. "" /*** Berechnet die Steigung einer Geraden . ** @ Param p1 Erster Punkt , die die Zeile beschreibt * @ param p2 zweite Punkt, die Linie beschreibt * @ return Steigung der Linie als float * /""
6
hinzufügen honorarfrei Tags. Die Tags führen den Code eines bestimmten Autors . "" /*** Berechnet die Steigung einer Geraden . ** @ Autor Jack Smith * @ param p1 Erster Punkt , die die Zeile beschreibt * @ param p2 zweite Punkt, die Linie beschreibt * @ return Steigung der Linie als float * /""
7
generieren Sie den HTML-Dokumentation . Wenn Sie nicht mit einer IDE oder Sie wollen einfach nur , um es manuell zu tun , können Sie die javadoc Kommandozeilen-Programm aus dem Projekt -Verzeichnis ausführen . Geben Sie die Ausgabe-Verzeichnis mit dem Schalter-d und geben sie eine Liste der . Java-Dateien (in der Regel als Platzhalter ) . " " Javadoc -d docs * . Java " "
