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

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

Dec 22, 2016 pm 01:15 PM

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)!


Erklärung dieser Website
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

Heiße KI -Werkzeuge

Undresser.AI Undress

Undresser.AI Undress

KI-gestützte App zum Erstellen realistischer Aktfotos

AI Clothes Remover

AI Clothes Remover

Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

Undress AI Tool

Undress AI Tool

Ausziehbilder kostenlos

Clothoff.io

Clothoff.io

KI-Kleiderentferner

Video Face Swap

Video Face Swap

Tauschen Sie Gesichter in jedem Video mühelos mit unserem völlig kostenlosen KI-Gesichtstausch-Tool aus!

Heiße Werkzeuge

Notepad++7.3.1

Notepad++7.3.1

Einfach zu bedienender und kostenloser Code-Editor

SublimeText3 chinesische Version

SublimeText3 chinesische Version

Chinesische Version, sehr einfach zu bedienen

Senden Sie Studio 13.0.1

Senden Sie Studio 13.0.1

Leistungsstarke integrierte PHP-Entwicklungsumgebung

Dreamweaver CS6

Dreamweaver CS6

Visuelle Webentwicklungstools

SublimeText3 Mac-Version

SublimeText3 Mac-Version

Codebearbeitungssoftware auf Gottesniveau (SublimeText3)

Wie kommentiere ich PHP-Funktionen mit Dokumentationskommentaren? Wie kommentiere ich PHP-Funktionen mit Dokumentationskommentaren? Apr 11, 2024 pm 04:48 PM

PHP-Dokumentationskommentare werden zum Kommentieren von Funktionen verwendet und enthalten die folgenden erforderlichen Felder: Beschreibung, Parameter (@param) und Rückgabewert (@return). Zu den optionalen Feldern gehören: Ausnahmen (@throws), Einführungsversion (@since) und Anwendungsbeispiele (@example). Verwenden Sie das PHPDocumentor-Tool, um eine HTML-Dokumentation zum Anzeigen kommentierter Funktionen zu generieren.

Codekommentare in PHP Codekommentare in PHP May 23, 2023 am 08:27 AM

Codekommentare sind Texterinnerungen, die Programmierer beim Schreiben von Code hinzufügen, um es ihnen selbst und anderen Programmierern zu erleichtern, den Code zu lesen und zu verstehen. In PHP sind Codekommentare unverzichtbar. In diesem Artikel werden die Typen, Spezifikationen und Verwendungsmöglichkeiten von Codekommentaren in PHP ausführlich vorgestellt. 1. Code-Kommentartypen in PHP In PHP gibt es drei Arten von Kommentaren: einzeilige Kommentare, mehrzeilige Kommentare und Dokumentationskommentare. Einzeilige Kommentare Ein einzeiliger Kommentar beginnt mit einem doppelten Schrägstrich „//“ und endet am Ende der Zeile. Beispiel: //Dies ist ein einzeiliger Kommentar. Mehrzeiliger Kommentar. Mehrzeiliger Kommentar endet mit „

Die komplementäre Beziehung zwischen Dokumentationskommentaren und Namenskonventionen bei der Benennung von C++-Funktionen Die komplementäre Beziehung zwischen Dokumentationskommentaren und Namenskonventionen bei der Benennung von C++-Funktionen May 03, 2024 am 09:00 AM

Konventionen zur Benennung von Funktionen und Dokumentationskommentare in C++ ergänzen sich gegenseitig und verbessern die Lesbarkeit des Codes. Namenskonventionen sorgen für klare und konsistente Funktionsnamen, während Dokumentationskommentare Details wie Zweck, Parameter, Rückgabewerte und Vorbedingungen ergänzen und sicherstellen, dass der Code leicht zu verstehen, zu warten und zu erweitern ist.

Java-Anfänger: Wie definiere ich die Einstiegsphase? Java-Anfänger: Wie definiere ich die Einstiegsphase? Feb 18, 2024 pm 06:29 PM

Erste Schritte mit Java: In welcher Lernstufe befindet sich der Anfänger? Als weit verbreitete Programmiersprache im Bereich der Softwareentwicklung ist Java leicht zu erlernen, plattformübergreifend und äußerst sicher und daher bei Programmierern sehr beliebt. Viele Anfänger hoffen, so schnell wie möglich mit Java durchstarten zu können und ihre Programmierreise zu beginnen. Wie beurteilen wir also, ob wir mit Java begonnen haben und welchen Schritt haben wir gelernt? Zunächst müssen wir ein Konzept klären: Der Einstieg bedeutet nicht, kompetent zu sein. Der Einstieg vervollständigt nur das vorläufige Verständnis und die Beherrschung der Java-Sprache

Wichtige Voraussetzungen für das Erlernen der Java-Technologie: Verständnis der Kernkonzepte und Anwendungstools Wichtige Voraussetzungen für das Erlernen der Java-Technologie: Verständnis der Kernkonzepte und Anwendungstools Jan 13, 2024 pm 03:02 PM

Grundlegende Kenntnisse zum Erlernen der Java-Technologie: Beherrschen Sie Schlüsselkonzepte und Entwicklungstools und benötigen Sie spezifische Codebeispiele. Java ist eine Computerprogrammiersprache, die im Bereich der Softwareentwicklung weit verbreitet ist. Seine Stärke liegt in seinen plattformübergreifenden Funktionen und der umfassenden Unterstützung von Entwicklungstools, was Java heute zu einer der beliebtesten Programmiersprachen macht. Wenn Sie die Java-Technologie erlernen möchten, ist die Beherrschung einiger Schlüsselkonzepte und Entwicklungstools unerlässlich. Dieser Artikel führt Sie in einige grundlegende Java-Kenntnisse ein und stellt einige spezifische Codebeispiele bereit, um Ihnen besser zu helfen

Vermittlung effizienter Lernmethoden für JAVA-Kernwissen Vermittlung effizienter Lernmethoden für JAVA-Kernwissen Nov 08, 2023 pm 06:44 PM

JAVA ist eine objektorientierte Programmiersprache, die im Bereich der Softwareentwicklung weit verbreitet ist. Die Beherrschung und kompetente Nutzung der Kernkenntnisse von JAVA ist für Programmierer von entscheidender Bedeutung. Dies kann die Entwicklungseffizienz verbessern und den Code zuverlässiger und einfacher zu warten machen. In diesem Artikel werden verschiedene Methoden zum effizienten Erlernen von JAVA-Kernkenntnissen vorgestellt und spezifische Codebeispiele bereitgestellt. 1. Grundlegende Schritte zum Erlernen grundlegender JAVA-Kenntnisse. Um eine neue Programmiersprache zu erlernen, müssen Sie zunächst deren grundlegende Syntax und Funktionen beherrschen. Für JAVA können Sie entsprechende Tutorials oder Bücher lesen

PHP-Kommentarspezifikation: So verwenden Sie Dokumentationskommentare zum Schreiben von API-Dokumentation PHP-Kommentarspezifikation: So verwenden Sie Dokumentationskommentare zum Schreiben von API-Dokumentation Jul 30, 2023 pm 07:00 PM

PHP-Kommentarspezifikation: So verwenden Sie Dokumentationskommentare zum Schreiben der API-Dokumentation. Einführung: Bei der Entwicklung von PHP-Anwendungen ist das Schreiben einer vollständigen API-Dokumentation für das Entwicklungsteam und andere Entwickler sehr wichtig. Eine gute Dokumentation verbessert die Lesbarkeit und Wartbarkeit des Codes und fördert die Teamarbeit und den Informationsaustausch. In diesem Artikel wird erläutert, wie Dokumentationskommentare zum Schreiben der PHP-API-Dokumentation verwendet werden, und einige Beispielcodes werden bereitgestellt, um den Lesern zu helfen, zu verstehen, wie Kommentare auf standardisierte Weise geschrieben werden. Kommentarspezifikation In PHP verwenden wir Kommentare, um den Code zu erklären und zu beschreiben. allgemein

Wie lassen sich die Anforderungen und Empfehlungen der neuesten PHP-Codespezifikationen in Projektdokumenten und Dokumentationskommentaren verdeutlichen? Wie lassen sich die Anforderungen und Empfehlungen der neuesten PHP-Codespezifikationen in Projektdokumenten und Dokumentationskommentaren verdeutlichen? Sep 05, 2023 pm 02:16 PM

Wie lassen sich die Anforderungen und Empfehlungen der neuesten PHP-Codespezifikationen in Projektdokumenten und Dokumentationskommentaren verdeutlichen? Einleitung: Bei der Entwicklung von PHP-Projekten ist es sehr wichtig, einheitliche Codespezifikationen zu befolgen. Gute Codespezifikationen können die Lesbarkeit und Wartbarkeit von Code verbessern, Codierungsfehler reduzieren und die Effizienz der Teamzusammenarbeit verbessern. Um die Qualität des Projektcodes sicherzustellen, muss das Entwicklungsteam die neuesten Anforderungen und Empfehlungen für die PHP-Codespezifikation klären. In diesem Artikel beschreiben wir, wie diese Anforderungen und Empfehlungen in der Projektdokumentation und in Dokumentationskommentaren explizit gemacht werden können, veranschaulicht durch Codebeispiele

See all articles