COMENTARII JAVA

Încercați-l pe GfG Practice

În Java, comentariile sunt declarații neexecutabile care explică codul și îmbunătățesc lizibilitatea. Ele sunt ignorate de compilator și nu afectează execuția programului.

Îmbunătățiți lizibilitatea și mentenabilitatea codului.
Util pentru depanarea și documentarea logicii.

Java acceptă trei tipuri principale de comentarii:

1. Comentarii pe o singură linie

Comentariile pe o singură linie sunt folosite pentru a comenta o singură linie de cod.

Sintaxă:

// Comentarii aici (Doar textul din acest rând este considerat comentariu)

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'  );         }   }

Ieșire

Single Line Comment Above

2. Comentarii pe mai multe rânduri

Comentariile pe mai multe rânduri sunt folosite pentru a descrie cod sau metode complexe, deoarece scrierea mai multor comentarii pe o singură linie poate fi plictisitoare.

/*
Începe comentariul
continuă
continua...
Comentariul se termină
*/

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    */      }   }

Ieșire

Multi Line Comments Below

3. Comentarii de documentare

Comentariile documentației sunt folosite pentru a genera documentație externă folosind Javadoc. Ele sunt utilizate în general în proiecte profesionale pentru a descrie metodele și parametrii claselor.

Sintaxă:

/**
* Începe comentariul
* @param descriere param-name
* @return descriere
*/

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  );      }   }