COMENTÁRIOS JAVA

Experimente no GfG Practice

Em Java, os comentários são instruções não executáveis que explicam o código e melhoram a legibilidade. Eles são ignorados pelo compilador e não afetam a execução do programa.

Melhore a legibilidade e a manutenção do código.
Útil para depurar e documentar lógica.

Java oferece suporte a três tipos principais de comentários:

1. Comentários de linha única

Comentários de linha única são usados para comentar uma linha de código.

Sintaxe:

// Comentários aqui (somente o texto nesta linha é considerado como comentário)

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

Saída

Single Line Comment Above

2. Comentários multilinhas

Comentários de várias linhas são usados para descrever códigos ou métodos complexos, pois escrever vários comentários de uma única linha pode ser entediante.

/*
O comentário começa
continua
continua...
O comentário 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    */      }   }

Saída

Multi Line Comments Below

3. Comentários sobre a documentação

Comentários de documentação são usados para gerar documentação externa usando Javadoc. Eles geralmente são usados em projetos profissionais para descrever métodos e parâmetros de classes.

Sintaxe:

/**
* Início do comentário
* @param descrição do nome do parâmetro
* @return descrição
*/

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