Java - Comentários

Conforme um programa se expande em tamanho e complexidade, fica cada vez mais complicado entendê-lo e saber o que cada parte faz. Para amenizar esse problema, é comum incluir comentários no código explicando brevemente o propósito de alguns trechos. Nessa seção, nós vamos discutir como incluir comentários em um programa escrito em Java.

O que são Comentários?

Comentários são textos inseridos em um código fonte que não instrui o computador a fazer alguma coisa. Esse texto é completamente ignorado na hora de gerar as instruções de máquina ou o bytecode no caso do Java. Isso faz dos comentários uma ótima ferramenta para inserir informações importantes para o programador lidando com o programa no próprio código fonte.

Comentário em Linha Única

Muitas linguagens de programação oferecem uma maneira de escrever comentários que se expandem por mais de uma linha, e outra para comentários em uma única linha.

Para escrever um comentário em uma única linha em Java usamos um par de barra // seguido do comentário que se deseja fazer.

class ComentarioDemo1 {
  public static void main (String[] args) {
    // Esse é um comentário qualquer - Será ignorado pelo compilador Java
    System.out.println("Olá, Mundo!");
  }
}

Apenas o que está na mesma linha e vem depois do par de barras é ignorado. Desse modo, podemos incluir comentários depois de uma instrução.

class ComentarioDemo2 {
  public static void main (String[] args) {
    System.out.println("Olá, Mundo!"); // Comentário qualquer - Será ignorado pelo compilador Java
  }
}

Comentário em Múltiplas Linhas

Comentários mais longos ou que precisam de múltiplas linhas, podem ser incluídos entre /* e */.

class ComentarioDemo3 {
  public static void main (String[] args) {
    /*
      Outro comentário explicando alguma parte
      importante do código ou passando 
      qualquer outra informação
      importante para quem está lendo o código.
    */
    System.out.println("Olá, Mundo!");
  }
}

Como os comentários são ignorados, eles podem conter qualquer coisa.

class ComentarioDemo4 {
  public static void main (String[] args){
    /*
                   ,----------------,              ,---------,
              ,-----------------------,          ,"        ,"|
            ,"                      ,"|        ,"        ,"  |
           +-----------------------+  |      ,"        ,"    |
           |  .-----------------.  |  |     +---------+      |
           |  |                 |  |  |     | -==----'|      |
           |  |  Amo código que |  |  |     |         |      |
           |  |  funciona       |  |  |-----|`---=    |      |
           |  |  C:\>_          |  |  |   ,/|==== ooo |      ;
           |  |                 |  |  |  // |(((( [33]|    ,"
           |  `-----------------'  |," .;'| |((((     |  ,"
           +-----------------------+  ;;  | |         |,"
              /_)______________(_/  //'   | +---------+
         ___________________________/___  `,
        /  oooooooooooooooo  .o.  oooo /,   \,"-----------
       / ==ooooooooooooooo==.o.  ooo= //   ,`\--{)B     ,"
      /_==__==========__==_ooo__ooo=_/'   /___________,"
    */
    System.out.println("Olá, mundo!");
  }
}

Apesar disso, os comentários o ideal é que eles informem algo útil para quem está lendo o código, e não atrapalhe seu entendimento.

A arte foi copiada de 30+ Piece of Art Code Comment People Ever Wrote in Code.

Essas são as maneiras de se comentar um código em Java. De inicio pode não parecer tão importante, mas conforme avança no desenvolvimento de um programa você perceber que comentários são fundamentais para manter o código inteligível.

Existe uma outra categoria de comentários usada junto a ferramenta javadoc para documentar classes, métodos e atributos, mas essa categoria será apresentada depois que forem apresentados a esses conceitos.