COMENTARIS DE JAVA

Prova-ho a GfG Practice

En Java, els comentaris són declaracions no executables que expliquen el codi i milloren la llegibilitat. El compilador els ignora i no afecten l'execució del programa.

Millorar la llegibilitat i el manteniment del codi.
Útil per depurar i documentar la lògica.

Java admet tres tipus principals de comentaris:

1. Comentaris d'una sola línia

Els comentaris d'una sola línia s'utilitzen per comentar una línia de codi.

Sintaxi:

// Comentaris aquí (el text d'aquesta línia només es considera comentari)

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

Sortida

Single Line Comment Above

2. Comentaris de diverses línies

Els comentaris de diverses línies s'utilitzen per descriure codi o mètodes complexos, ja que escriure diversos comentaris d'una sola línia pot ser tediós.

/*
Comença el comentari
continua
continua...
El comentari acaba
*/

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

Sortida

Multi Line Comments Below

3. Comentaris de documentació

Els comentaris de documentació s'utilitzen per generar documentació externa mitjançant Javadoc. S'utilitzen generalment en projectes professionals per descriure mètodes i paràmetres de classes.

Sintaxi:

/**
* Comença el comentari
* @param descripció del nom-param
* @return descripció
*/

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