Wie man in Java kommentiert?

Befehle sind bei der Computerprogrammierung sehr wichtig. Dies sind einfache Erklärungen des Quellcodes, die den Quellcode für den Menschen verständlicher machen. Diese werden jedoch weder vom Compiler noch vom Dolmetscher berücksichtigt.

Bedeutung von Kommentaren

Wie oben erläutert, sind Kommentare erforderlich, weil sie ein Computerprogramm verständlicher machen. Vorteile von Kommentaren sind unten aufgeführt.

• Macht den Code leicht zu lesen.
• Mühelose Code -Wartung und Fehlererkennung.
• Geben Sie Details zu einer bestimmten Methode, Klasse, Variablen oder Anweisung an.
• Funktionen, die zur Verwendung von anderen geschrieben wurden, werden leichter zu verstehen.

Wie in anderen Programmiersprachen können Sie auch Kommentare in Java schreiben. In diesem Schreiben werden verschiedene Arten von Java-Kommentaren untersucht und wie man sie zusammen mit ihren Beispielen verwendet.

Arten von Java -Kommentaren

In Java gibt es drei Ansätze zum Kommentieren, wie unten gezeigt.

Einzelzeilenkommentar

Um eine einzelne Zeile zu kommentieren einzelne Zeilen Kommentare, die mit zwei Stürmer -Schrägstrichen beginnen. Der nach diesen Vorwärtsströmen geschriebene Text wird vom Java -Compiler ignoriert.

Hier ist die Syntax des Java-Single-Line-Kommentars:

// Dies ist ein einzelner Kommentar

Beispiel

Multi-Line-Kommentar

Wenn Sie mehrere Zeilen in Ihrem Java-Quellcode kommentieren möchten, verwenden Sie einen mehrzeiligen Kommentar. Es beginnt mit / * und endet mit * /. Der dazwischen geschriebene Text wird vom Java -Compiler nicht ausgeführt.

Syntax

/ * Dies ist ein Mehrzeilungskommentar */

Beispiel

Dokumentationskommentar

Dokumentationskommentare werden normalerweise beim Erstellen von Dokumentations -API für größere Java -Programme verwendet. Diese Dokumentations -APIs werden verwendet, um Klassen, Methoden und Argumente im Quellcode zu referenzieren. Es beginnt mit /** und endet mit* /.

Hier ist die Syntax des Dokumentationstyp -Kommentars in Java.

/**
*
*Um Parameter darzustellen, verwenden wir verschiedene Tags
*oder Methode oder Überschrift
*Oder wir können HTML -Tags verwenden
*
*/

Beispiel

Die unten angegebene Tabelle deckt mehrere Arten von Javadoc -Tags ab.

Verlinke den Namen	Syntax	Beschreibung
@Autor	@Author Name-Text	Es wird verwendet, um den Autoramen einer bestimmten Klasse zu schreiben.
@Ausführung	@Version Version-Text	Es wird verwendet, um den Versionstext zu erwähnen.
@param	@Param-Parameter-Name Beschreibung	Es wird verwendet, um den Parameternamen und die Beschreibung hinzuzufügen.
@zurückkehren	@Return Beschreibung	Es wird verwendet, um die Rückgabewerte leicht zu finden, indem ein Abschnitt „Returns“ erstellt wird.
@veraltet	@deprecated veralteter Text	Es wird zur Anzeige einer veralteten Klasse oder Methode verwendet oder eingereicht und erstellt jedes Mal, wenn sie von jemandem verwendet wird.
@seit	@Since Release	Es wird verwendet, um die Version der Methode oder Klasse usw. anzugeben, indem der Abschnitt „seit“ hinzugefügt wird.
@throws	@Throws Klassenname Beschreibung	Es wird verwendet, um eine Ausnahme auszulösen.
@Ausnahme	@Exception Klassenname Beschreibung	Es hat eine ähnliche Verwendung wie das @Throw -Tag.
@sehen	@see Referenz	Es wird verwendet, um eine Verweise auf eine Methode oder Klasse hinzuzufügen, indem ein Link im Abschnitt „Siehe auch“ generiert wird.
@Serial	@Serial Field-Decription | inklusive | ausschließen	Es wird verwendet, um relevante Informationen zu serialisierten Feldern hinzuzufügen.
@Serialfield	@Serial Field-Name-Feldtyp-Feldbeschreibung	Es wird verwendet, um die Objektstreamfield -Komponente zu dokumentieren.
@serialdata	@Serialdata Datendeschreibung	Es wird verwendet, um Daten zu dokumentieren, die mit Methoden wie WriteObject () oder WriteExternal () verfasst wurden.
@docroot	@docroot	Es wird verwendet, um Root Directory -Pfad anzuzeigen.
@Code	@code text	Es wird zum Anzeigen von Text in Code -Schriftarten verwendet.
@Wert	@Value -Paket.Feld##	Es wird verwendet, um den Wert der Konstante anzuzeigen, wenn ein DOC -Kommentar in einem statischen Feld geschrieben ist.
@inheritdoc	-	Es wird verwendet, um einen Kommentar aus einer vererbbaren Klasse zu erben.
@Verknüpfung	@link Paket.Klasse#Mitgliedslabel	Es enthält einen Link, der die Dokumentation für ein bestimmtes Paket, eine bestimmte Klasse oder einen Mitgliedsnamen einer überweisenden Klasse konzentriert.
@linkplain	@linkplain Paket.Klasse#Mitgliedslabel	Ähnlich wie bei Link mit dem einzigen Unterschied, dass die Beschriftung des Links eher im Klartext als im Codentext angezeigt wird.

Abschluss

Es gibt drei Arten von Kommentaren in Java. Der erste ist ein einzelner Kommentar, der mit zwei Stürmer-Slashes '//' beginnt. Der zweite ist ein Mehrzeilungskommentar, der mit/ * endet und mit */endet, während der letzte Dokumentationskommentar, der zum Erstellen verwendet wird Dokumentations -API für große Java -Programme und -anwendungen. Alle diese Arten von Kommentaren werden in diesem Tutorial zusammen mit Javadoc -Tags erläutert, die in Dokumentationskommentaren verwendet werden.