Welche Funktion hat das JDK-Tool Javadoc?-JavaBase-php.cn

Welche Funktion hat das JDK-Tool Javadoc?

青灯夜游

Freigeben： 2020-10-29 09:08:01

Original

5675 Leute haben es durchsucht

Die Funktion des JDK-Tools Javadoc besteht darin, „Java-Dokumentation zu generieren“. Javadoc ist ein Java-Dokumentationsgenerator, der Kommentare wie Klassen, Methoden, Mitglieder usw. aus dem Programmquellcode extrahiert, um ein API-Hilfedokument zu erstellen, das dem entspricht Quellcode.

Welche Funktion hat das JDK-Tool Javadoc?

Verwandte Empfehlungen: „Java Video Tutorial“

Die Funktion des JDK-Tools Javadoc besteht darin, „Java-Dokumentation zu generieren“.

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.

Mit dem Befehl javadoc können Sie Ihre eigene API-Dokumentation erstellen: Geben Sie über die Befehlszeile javadoc + Dateiname.java in das Verzeichnis ein, in dem sich die Zieldatei befindet.

Gemeinsame Tags

Tags	Beschreibung	JDK 1.1-Doclet	Standard-Doclet	Tag-Typ
@Autor Autor	Autorenidentifikation	√	√	Paket, Klasse , Schnittstelle
@Version Versionsnummer	Versionsnummer	√	√	Paket, Klasse, Schnittstelle
@param Parametername Beschreibung	Der Eingabeparametername und die Beschreibungsinformationen der Methode, z als Eingabeparameter Wenn Sie spezielle Anforderungen haben, kommentieren Sie diese bitte hier.	√	√	Konstruktor, Methode
@return Beschreibung	Kommentar zur Funktionsrückgabe. Wert	√	√	Methode
@depre kategorisierter abgelaufener Text	Logo kommt mit dem Programm The Beim Versionsupgrade ist die aktuelle API abgelaufen. Dies dient nur dazu, sicherzustellen, dass die Kompatibilität weiterhin besteht, und um Entwickler darüber zu informieren, dass sie diese API nicht mehr verwenden sollten.	√	√	Paket, Klasse, Schnittstelle, Wertebereich, Konstruktor, Methode
@throwsException Klassenname	Ausnahme, die vom Konstruktor oder der Methode ausgelöst wird.		√	Konstruktor, Methode
@Exception Name der Ausnahmeklasse	wie @throws.	√	√	Konstruktor, Methode
@see Quote	Zugehörige Inhalte wie Klassen, Methoden, Variablen usw. anzeigen.	√	√	Paket, Klasse, Schnittstelle, Wertebereich, Konstruktor, Methode
@seit Beschreibungstext	API wird nach welchem Programm und welcher Version entwickelt und unterstützt.	√	√	Paket, Klasse, Schnittstelle, Wertebereich, Konstruktor, Methode
{@link package.class#member tag}	Link zum Dokument, das einem bestimmten Mitglied entspricht.		√	Paket, Klasse, Schnittstelle, Wertebereich, Konstruktor, Methode
{@value}	Wenn Sie eine Konstante mit Anmerkungen versehen und deren Wert in das Dokument aufnehmen möchten, übergeben Sie diese Bezeichnung auf den Wert einer Konstanten.		√(JDK1.4)	Statischer Wertebereich

Darüber hinaus gibt es @serial, @serialField, @serialData, {@docRoot}, {@inheritDoc}, {@literal}, {@code} {@value arg} Da sie nicht häufig verwendet werden, können interessierte Leser die Hilfedokumentation lesen.

Weitere Kenntnisse zum Thema Programmierung finden Sie unter: Einführung in die Programmierung! !

Das obige ist der detaillierte Inhalt vonWelche Funktion hat das JDK-Tool Javadoc?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!