COMMENTI JAVA

Provalo su GfG Practice

In Java i commenti sono istruzioni non eseguibili che spiegano il codice e migliorano la leggibilità. Vengono ignorati dal compilatore e non influiscono sull'esecuzione del programma.

Migliora la leggibilità e la manutenibilità del codice.
Utile per il debug e la documentazione della logica.

Java supporta tre tipi principali di commenti:

1. Commenti a riga singola

I commenti a riga singola vengono utilizzati per commentare una riga di codice.

Sintassi:

// Commenti qui (Solo il testo in questa riga è considerato come commento)

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

Produzione

Single Line Comment Above

2. Commenti su più righe

I commenti su più righe vengono utilizzati per descrivere codici o metodi complessi poiché scrivere più commenti su una riga singola può essere noioso.

/*
Inizia il commento
continua
continua...
Il commento termina
*/

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

Produzione

Multi Line Comments Below

3. Commenti sulla documentazione

I commenti sulla documentazione vengono utilizzati per generare documentazione esterna utilizzando Javadoc. Sono generalmente utilizzati nei progetti professionali per descrivere metodi e parametri delle classi.

Sintassi:

/**
* Inizio commento
* @param descrizione nome-param
* Descrizione @return
*/

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