Java-Kommentare

Java-Kommentare
Probieren Sie es bei GfG Practice aus

Kommentare sind in Java nicht ausführbare Anweisungen, die Code erklären und die Lesbarkeit verbessern. Sie werden vom Compiler ignoriert und haben keinen Einfluss auf die Programmausführung.

  • Verbessern Sie die Lesbarkeit und Wartbarkeit des Codes.
  • Nützlich zum Debuggen und Dokumentieren von Logik.

Java unterstützt drei Haupttypen von Kommentaren:

1. Einzeilige Kommentare

Einzeilige Kommentare werden verwendet, um eine Codezeile zu kommentieren.

Syntax:   

// Kommentare hier (nur Text in dieser Zeile wird als Kommentar betrachtet)

Java
   // Java program to show single line comments   class   GFG   {      public     static     void     main  (  String     args  []  )      {         // Single line comment here      System  .  out  .  println  (  'Single Line Comment Above'  );         }   }   

Ausgabe
Single Line Comment Above  

2. Mehrzeilige Kommentare

Mehrzeilige Kommentare werden zur Beschreibung komplexer Codes oder Methoden verwendet, da das Schreiben mehrerer einzeiliger Kommentare mühsam sein kann.

/*
Der Kommentar beginnt
geht weiter
geht weiter...
Kommentar endet
*/

Java
   class   GFG   {      public     static     void     main  (  String     args  []  )      {         System  .  out  .  println  (  'Multi Line Comments Below'  );          /* Comment line 1    Comment line 2     Comment line 3    */      }   }   

Ausgabe
Multi Line Comments Below  

3. Kommentare zur Dokumentation

Dokumentationskommentare werden verwendet, um externe Dokumentation mit Javadoc zu generieren. Sie werden im Allgemeinen in professionellen Projekten verwendet, um Klassenmethoden und -parameter zu beschreiben.

Syntax:   

/**
* Kommentarstart
* @param param-name Beschreibung
* @return Beschreibung
*/

Java
   /**    *     * Calculates the average of three integers.    * @author Pratik Agarwal    * @version 1.0    * @since 2017-02-18    */   public     class   FindAvg  {      /**    * Finds average of three integers.    * @param numA First parameter    * @param numB Second parameter    * @param numC Third parameter    * @return Average of numA numB and numC    */      public     int     findAvg  (  int     numA       int     numB       int     numC  )      {      return     (  numA     +     numB     +     numC  )     /     3  ;      }      /**    * Main method which uses findAvg method    * @param args Unused    */      public     static     void     main  (  String     args  []  ){      FindAvg     obj     =     new     FindAvg  ();      int     avg     =     obj  .  findAvg  (  10       20       30  );      System  .  out  .  println  (  'Average of 10 20 and 30 is: '      +     avg  );      }   }   

Ausgabe
Average of 10 20 and 30 is: 20  

Verwandter Artikel: JavaDoc-Tool


Quiz erstellen