Java-Blockkommentare

In Java verwenden wir Kommentare, um die Lesbarkeit von Java-Code zu verbessern, indem wir zusätzliche Erklärungen und Informationen zum Code bereitstellen, wodurch der Code gewartet und Bugs und Fehler leicht gefunden werden können. Beim Kompilieren des Java-Codes schließt der Compiler den Text und die Anweisungen innerhalb der Kommentare vollständig aus.

In diesem Lehrgang werden wir Blockkommentare in Java besprechen.

Der Blockkommentar wird verwendet, um viele Codezeilen gleichzeitig zu kommentieren. Wir verwenden /* und */, um Blockkommentare einzufügen. Blockkommentare können sich über viele Zeilen erstrecken oder in eine Codeanweisung eingefügt werden. Nur der Text zwischen Kommentartrennzeichen gilt als Bemerkung und wird bei der Kompilierung nicht berücksichtigt.

Zum Beispiel,

public class multilinecomment {
  public static void main(String[] args) {
    /* we have declared an integer n having value 007
    and a floating point variable z
    storing value of pi. */
    int n = 007;
    double z = 3.14;
    System.out.println(n);
    System.out.println(z);
  }
}

Ausgabe:

7
3.14

In Java steht eine weitere Art von mehrzeiligen Kommentaren zur Verfügung. Dazu verwenden wir das /** und */ um Dokumentationskommentare einzufügen. Dies wird verwendet, um formale Dokumentations-APIs für Ihre Programme zu definieren, die mit dem Tool javadoc erstellt werden. Das javadoc ist ein Werkzeug, das die Deklarationen und Dokumentationskommentare in einer Sammlung von Quelldateien analysiert und eine Sammlung von HTML-Seiten generiert, die die Klassen, Schnittstellen, Konstruktoren, Methoden und Felder beschreiben.

Zum Beispiel,

public class javadoccomment {
  /**  multi() method returns multiplication of numbers.*/
  public static int multi(int a, int b) {
    return a * b;
  }

  /**  addition() method returns addition of numbers.*/
  public static int addition(int a, int b) {
    return a + b;
  }

  /**  subtract() method returns subtraction of numbers.*/
  public static int subtract(int a, int b) {
    return a - b;
  }
  public static void main(String[] args) {}
}

Wenn wir den oben angegebenen Code mit dem Tool javac kompilieren, erhalten wir javadoccomment.java, und dann wird eine HTML-Datei für die Klasse javadoccomment erstellt. Öffnen Sie die angegebene HTML-Datei und sehen Sie sich den Dokumentationskommentar für die Klasse javadoccomment an.