logo

Java-Kommentare

Der Java Kommentare sind die Anweisungen in einem Programm, die nicht vom Compiler und Interpreter ausgeführt werden.

Warum verwenden wir Kommentare in einem Code?

  • Kommentare werden verwendet, um das Programm lesbarer zu machen, indem sie die Details des Codes hinzufügen.
  • Es erleichtert die Pflege des Codes und das einfache Auffinden von Fehlern.
  • Die Kommentare können verwendet werden, um Informationen oder Erläuterungen zum Thema bereitzustellen Variable , Methode, Klasse , oder irgendeine Aussage.
  • Es kann auch verwendet werden, um die Ausführung von Programmcode zu verhindern, während der Alternativcode getestet wird.

Arten von Java-Kommentaren

In Java gibt es drei Arten von Kommentaren.

  1. Einzeiliger Kommentar
  2. Mehrzeiliger Kommentar
  3. Dokumentationskommentar
Java-Kommentartypen

1) Einzeiliger Java-Kommentar

Der einzeilige Kommentar wird verwendet, um nur eine Zeile des Codes zu kommentieren. Es ist die am weitesten verbreitete und einfachste Möglichkeit, Aussagen zu kommentieren.

Einzeilige Kommentare beginnen mit zwei Schrägstrichen (//) . Jeder Text vor // wird von Java nicht ausgeführt.

Syntax:

 //This is single line comment 

Lassen Sie uns einen einzeiligen Kommentar in einem Java-Programm verwenden.

CommentExample1.java

 public class CommentExample1 { public static void main(String[] args) { int i=10; // i is a variable with value 10 System.out.println(i); //printing the variable i } } 

Ausgabe:

 10 

2) Mehrzeiliger Java-Kommentar

Der mehrzeilige Kommentar wird zum Kommentieren mehrerer Codezeilen verwendet. Es kann verwendet werden, um einen komplexen Codeausschnitt zu erklären oder mehrere Codezeilen gleichzeitig zu kommentieren (da es dort schwierig sein wird, einzeilige Kommentare zu verwenden).

Mehrzeilige Kommentare werden zwischen /* und */ platziert. Jeder Text zwischen /* und */ wird von Java nicht ausgeführt.

Syntax:

wie man einen Zeiger in c dereferenziert
 /* This is multi line comment */ 

Lassen Sie uns einen mehrzeiligen Kommentar in einem Java-Programm verwenden.

CommentExample2.java

 public class CommentExample2 { public static void main(String[] args) { /* Let's declare and print variable in java. */ int i=10; System.out.println(i); /* float j = 5.9; float k = 4.4; System.out.println( j + k ); */ } } 

Ausgabe:

 10 

Hinweis: Normalerweise wird // für kurze Kommentare und /* */ für längere Kommentare verwendet.

3) Kommentar zur Java-Dokumentation

Dokumentationskommentare werden normalerweise zum Schreiben großer Programme für ein Projekt oder eine Softwareanwendung verwendet, da sie die Erstellung einer Dokumentations-API unterstützen. Diese APIs werden als Referenz benötigt, d. h. welche Klassen, Methoden, Argumente usw. im Code verwendet werden.

Um eine Dokumentations-API zu erstellen, müssen wir die verwenden Javadoc-Tool . Die Dokumentationskommentare werden zwischen /** und */ platziert.

Syntax:

 /** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */ 

Javadoc-Tags

Einige der häufig verwendeten Tags in Dokumentationskommentaren:

Etikett Syntax Beschreibung
{@docRoot} {@docRoot} um den relativen Pfad zum Stammverzeichnis des generierten Dokuments von einer beliebigen Seite aus darzustellen.
@Autor @Autorenname – Text Um den Autor der Klasse hinzuzufügen.
@Code {@code text} Um den Text in Codeschriftart anzuzeigen, ohne ihn als HTML-Markup oder verschachteltes Javadoc-Tag zu interpretieren.
@Ausführung @version version-text Zur Angabe der Unterüberschrift „Version“ und des Versionstexts, wenn die Option -version verwendet wird.
@seit @seit Veröffentlichung Hinzufügen der Überschrift „Seitdem“ mit „Seitdem“-Text zur generierten Dokumentation.
@param Beschreibung des Parameternamens @param So fügen Sie einen Parameter mit gegebenem Namen und Beschreibung zum Abschnitt „Parameter“ hinzu.
@zurückkehren @return Beschreibung Erforderlich für jede Methode, die etwas zurückgibt (außer void)

Lassen Sie uns das Javadoc-Tag in einem Java-Programm verwenden.

Berechnen.java

 import java.io.*; /** * <h2> Calculation of numbers </h2> * This program implements an application * to perform operation such as addition of numbers * and print the result * <p> * <b>Note:</b> Comments make the code readable and * easy to understand. * * @author Anurati * @version 16.0 * @since 2021-07-06 */ public class Calculate{ /** * This method calculates the summation of two integers. * @param input1 This is the first parameter to sum() method * @param input2 This is the second parameter to the sum() method. * @return int This returns the addition of input1 and input2 */ public int sum(int input1, int input2){ return input1 + input2; } /** * This is the main method uses of sum() method. * @param args Unused * @see IOException */ public static void main(String[] args) { Calculate obj = new Calculate(); int result = obj.sum(40, 20); System.out.println(&apos;Addition of numbers: &apos; + result); } } </p>

Kompilieren Sie es mit dem Javac-Tool:

Dokument erstellen

Java-Kommentare

Erstellen Sie eine Dokumentations-API von Javadoc Werkzeug:

Java-Kommentare

Nun werden die HTML-Dateien für erstellt Berechnung Klasse im aktuellen Verzeichnis, d. h. abcDemo . Öffnen Sie die HTML-Dateien und wir können die Erklärung der Calculate-Klasse sehen, die im Dokumentationskommentar bereitgestellt wird.

Sind Java-Kommentare ausführbar?

Jahre: Wie wir wissen, werden Java-Kommentare nicht vom Compiler oder Interpreter ausgeführt. Vor der lexikalischen Transformation des Codes im Compiler werden jedoch die Inhalte des Codes in ASCII codiert, um die Verarbeitung zu vereinfachen.

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println(&apos;Java comment is executed!!&apos;); } } 

Ausgabe:

Java-Kommentare

Der obige Code generiert die Ausgabe, da der Compiler das Unicode-Zeichen analysiert. u000d Als ein Neue Zeile vor der lexikalischen Transformation, und somit wird der Code wie unten gezeigt transformiert:

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println(&apos;Java comment is executed!!&apos;); } } 

Somit verschiebt das Unicode-Zeichen die Druckanweisung in die nächste Zeile und sie wird als normaler Java-Code ausgeführt.