Wie erstelle ich eine Dokumentation mithilfe von Java-Dokumentationskommentaren?

Wir wissen, dass Java drei Arten von Kommentaren unterstützt, nämlich einzeilige Kommentare, mehrzeilige Kommentare und Dokumentkommentare. Schauen wir uns an, wie sie aussehen.

// Einzeilige Kommentare. Zeilenkommentare
*/

/ **
*@...
*....
*Dokumentationskommentare
*/


Vielleicht verstehen viele Neulinge nicht, welchen Sinn es hat, diese Kommentare zu schreiben?

Tatsächlich liegt es daran, dass Anfänger nur über eine kleine Menge Code verfügen und diesen ohne Kommentare schnell finden und ändern können.

Wenn der Code nach und nach größer wird, sind Kommentare eine gute Sache, nicht nur, damit Sie den Code klar sehen können. sondern auch, um mit anderen zu kommunizieren. Eine Annehmlichkeit für Mitglieder, die gemeinsam mit Ihnen Projekte entwickeln. Denken Sie daran, diese schlechte Angewohnheit, keine Kommentare zu schreiben, loszuwerden! ! !

So, hier kommt heute unser Thema: Was sind Doc-Kommentare?

Javadoc ist eine von Sun bereitgestellte Technologie. Sie extrahiert Kommentare wie Klassen, Methoden, Mitglieder usw. aus dem Programmquellcode, um ein API-Hilfedokument zu erstellen, das dem Quellcode entspricht. Mit anderen Worten: Solange Sie beim Schreiben eines Programms einen bestimmten Satz von Tags als Kommentare verwenden, kann nach dem Schreiben des Programms gleichzeitig die Entwicklungsdokumentation des Programms über Javadoc erstellt werden.

Der Befehl javadoc wird zum Generieren der API-Dokumentation verwendet: Geben Sie über die Befehlszeile javadoc + Dateiname.java in das Verzeichnis ein, in dem sich die Zieldatei befindet.

Sie müssen sich nicht darauf einlassen Man muss diese komplizierten Theorien kultivieren, um sie zu verstehen, zu verstehen, tiefer zu gehen, sie zu ändern, sie zu verstehen, und das Festhalten an der Theorie wird keine Wirkung haben!

Wenn wir Code schreiben, gibt es Standards. Wenn der Code, den Sie schreiben, ein Chaos ist, ist niemand bereit, ihn zu verwenden, weil er schwierig zu warten ist In der Online-Welt nenne ich es lieber ein Kunstwerk, das Ihre sorgfältige Gravur erfordert

Manche Leute sagen vielleicht: Ist das nicht nur eine Anmerkung? Was hat es damit auf sich? Dieser Doc-Kommentar ist jedoch nicht dasselbe wie die anderen beiden Kommentare. Es gibt auch Standards für Kommentare!

Dokumentanmerkungsspezifikationen

Format:

Zu Klassen geschriebene Dokumentanmerkungen sind im Allgemeinen in drei Absätze unterteilt:

Erster Absatz: Zusammenfassende Beschreibung, normalerweise ein Satz oder ein Absatz zur kurzen Beschreibung der Funktion der Klasse, mit einem englischen Punkt als Ende

Zweiter Absatz: Detaillierte Beschreibung, normalerweise werden ein oder mehrere Absätze verwendet, um die Funktion der Klasse im Detail zu beschreiben. Im Allgemeinen endet jeder Absatz mit einem englischen Punkt

Dritter Absatz: Dokumentanmerkung, die zur Kennzeichnung des Autors verwendet wird und Erstellungszeit, Referenzklassen und andere Informationen

Hier möchte ich ein wenig Wissen erweitern. Unsere Doc-Kommentare können Dos-Befehle oder IDE-Tools verwenden, um ein Doc-Dokument zu generieren, sodass einige einfache HTML-Codes möglich sind in den Kommentaren verwendet werden. , wie zum Beispiel der folgende

Zeilenumbruch

Absatz

(vor dem Absatz geschrieben)

Fügen Sie ein Beispiel-Stildiagramm ein:

Die Verwendung des @-Symbols

Wir schreiben Doc. Drücken Sie beim Kommentieren direkt nach /** die Eingabetaste, und der folgende Kommentarrahmen und einige @-Symbole werden automatisch generiert. Wozu dienen diese @-Symbole?

Beschreiben Sie ein Serialisierungsattribut.@Serial-Beschreibung. @SerialData Feldkomponente @serialFeldname Typbeschreibung@ seitGeben Sie an, in welcher Version sich diese Funktion seit @seit der Veröffentlichung befindet@throws ist dasselbe wie das @Exception-Tag.Das @throws-Tag hat die gleiche Bedeutung wie das @Exception-Tag.{@value}Zeigt den Wert einer Konstante an, die ein statisches Attribut sein muss. Zeigt den Wert einer Konstante an, die ein statisches Feld sein muss.@VersionGibt die Version der Klasse an, die im Allgemeinen für Klassenanmerkungen verwendet wird.@VersionsinformationenErstens: DOS-Befehlsgenerierung javadoc [Optionen] [Paketnamen] [Quelldateien]optionen stellt die Optionen des Javadoc-Befehls dar; NameBeschreibung-publicNur öffentliche Klassen und Mitglieder anzeigen- protectedgeschützte/öffentliche Klassen und Mitglieder anzeigen (Standard)-Paket Zielverzeichnis für die Ausgabedatei-splitindex

Tag	Beschreibung	Beispiel
@author	identifiziert den Autor einer Klasse, wird im Allgemeinen für Klassenanmerkungen verwendet	@author-Beschreibung
@deprecated	bezeichnet eine abgelaufene Klasse oder ein abgelaufenes Mitglied , was darauf hinweist, dass die Verwendung der Klasse oder Methode nicht empfohlen wird der Ausnahme, die ausgelöst werden kann. Wird im Allgemeinen für Methodenkommentare verwendet.	@Exception-Erklärung des Ausnahmenamens ein Inline-Link Fügt einen Inline-Link zu einem anderen Thema ein.
@param	Beschreibt die Parameter einer Methode, die im Allgemeinen für Methodenkommentare verwendet werden	@param Erklärung des Parameternamens
@return	Beschreibt den Rückgabewerttyp, der im Allgemeinen für Methodenkommentare verwendet wird. Kann nicht in der Konstruktionsmethode erscheinen
@Teil I Hier ist Auf Englisch können Sie Chinesisch schreiben, z. B. @author Xiaojian	So generieren Sie ein Doc-Dokument	Wir haben oben gesagt, dass nach dem Schreiben von Doc-Kommentaren ein Doc-Dokument generiert werden kann, und zwar im HTML-Format Wie erzeugen wir es?
		Erklärung des Formats:
packagenames stellt den Paketnamen dar;	sourcefiles stellt den Namen der Quelldatei dar	Sie können ihn sehen, indem Sie javadoc -help in cmd eingeben (Eingabeaufforderung). ) Javadoc-Verwendung und -Optionen (vorausgesetzt, dass JDK installiert und konfiguriert ist), die allgemeinen Optionen des Javadoc-Befehls sind unten aufgeführt:
		-d
	-version	enthält das @version-Segment
-author	enthält das @author-Segment

Splits Der Index in jeden Buchstaben, der einer Datei entspricht

-windowtitle

Der Browserfenstertitel des Dokuments

ist mit Doc mühsam und langsam zu generieren. Gibt es eine andere Methode?

Zweitens: IDE-Tool-Generierung

Wir können Eclipse oder IDEA verwenden, um es zu generieren. Ich verwende Eclipse nicht oft. options 表示 Javadoc 命令的选项；

packagenames 表示包名；

sourcefiles 表示源文件名;

在 cmd（命令提示符）中输入javadoc -help

Im JavaDoc im Tool sieht es nach der Eingabe so aus Das Ausgabeverzeichnis muss ausgewählt werden, sonst wird es nicht generiert

-encoding utf8 -docencoding utf8 -charset utf8

Achtung, da die Kodierung von Java anders ist das von IDEA, also in anderen In der Befehlsparameterspalte müssen Sie den folgenden Inhalt ausfüllen	Nach der Generierung sieht es so aus

Das obige ist der detaillierte Inhalt vonWie erstelle ich eine Dokumentation mithilfe von Java-Dokumentationskommentaren?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!