Heim  >  Artikel  >  Java  >  Einführung in Java Basics Essay (9) JavaSE Edition – Kommentare zur Dokumentation

Einführung in Java Basics Essay (9) JavaSE Edition – Kommentare zur Dokumentation

黄舟
黄舟Original
2016-12-22 13:15:591322Durchsuche

Im vorherigen Abschnitt haben wir über die Definition und Verwendung einiger statischer Variablen und statischer Methoden sowie die Unterschiede zwischen ihnen und nichtstatischen Methoden geschrieben. Dieser Abschnitt fügt hinzu:

Wenn alle Methoden in a Die Klasse ist statisch und es gibt keine Mitgliedsvariablen. Zu diesem Zeitpunkt müssen Sie die entsprechende Klasse einschränken. Die spezifischen Operationen sind wie folgt:

PRivate ArrayTool(){}

//Die Methoden in dieser Klasse sind alle statisch, sodass diese Klasse keine Objekte erstellen muss. Um zu verhindern, dass andere Objekte dieser Klasse erstellen, können Sie den Konstruktor dieser Klasse privat machen.

1. Dokumentationskommentare

Verwenden Sie das Javadoc-Tool in der Java-Fake-Maschine, um Dokumentationskommentare zu generieren, und verwenden Sie die Dokumentationskommentare im Code, um sie zu generieren.

Hinweis:

1. Jede Kompilierungseinheit (Klassendatei) kann nur eine öffentliche Klasse haben
2. Der Name der öffentlichen Klasse (einschließlich Groß- und Kleinschreibung) muss der sein Gleich wie seine Klassendatei. Gleicher Name.
3. Die öffentliche Klasse muss nicht in einer Klassendatei (*.java) vorhanden sein.

Javadoc-Tag verwenden:

Javadoc-Tag besteht aus „@“, gefolgt vom Tag-Typ und einer speziellen Kommentarreferenz
Javadoc-Tags enthalten Folgendes:
@Autorenbezeichnung Der Autor, der hat diesen Modultyp entwickelt
@version gibt die Version dieses Modultyps an
@siehe Referenzsteuerung, also verwandte Themen
@param Beschreibung eines bestimmten Parameters in der Methode
@return Rückgabe Wert der Methode Beschreibung von
@Exception erklärt die Ausnahmen, die von der Methode ausgelöst werden können

Das Obige ist der Inhalt von Java Basics Introduction Essay (9) JavaSE Edition – Dokumentationskommentare für weitere verwandte Inhalte Bitte achten Sie auf die chinesische PHP-Website (www.php.cn)!


Stellungnahme:
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn