Comentários

Comentários, como o próprio nome instiga, são notas que podem ser incluídas no código fonte para descrever o que se quiser. Assim, não modificam o programa executado e servem somente para ajudar o programador a melhor organizar os seus códigos. Os comentários em Java seguem a mesma sintaxe da linguagem C++.

Linha única

Para representar uma linha de comentário utilizamos o prefixo // e assim todo o conteúdo deixará de ser interpretado pelo processo de checagem e compilação.

{
    // esta linha é um comentário e abaixo parte de nosso algoritmo
    int a=10;
}

Outro exemplo

{
   // este é um bloco de programação
   int a=10;
   int b=1;
   if (b==3) {
       // este é um bloco que é executado se b for igual a 3
       b=a*10;
   } else {
       // este é um bloco que é executado se b for diferente de 3
       int a=100;
       b=a*10;
   }
   System.out.println("O valor de b é " + b);
}

Múltiplas linhas

Às vezes nosso comentário precisará ser um pouco mais esclarecedor necessitando assim mais de uma linha. Neste cenário, utilizamos os símbolos /* */ para esta finalidade.

{
   int a=10;
   int b;
   b=a*2;
   
   /* a partir deste ponto, deve-se começar a exibir 
   os resultados na tela do usuário */
}

Abaixo iremos demonstrar o mesmo algoritmo primeiro sem usar das boas práticas e em seguida uma refatoração mais legível.

// Classe que representa uma calculadora
public class Calc {
  int tot=0; //variavel que representa o total atual
  
  //metodo somar que recebe numero um e numero dois
  public int sm(int n, String m) {
      //como o parametro dois é uma String precisa converter para numero
      int n2 = Integer.parseInt(m);
      this.tot = n + n2;
      return tot;
  }
}

public class Calculadora {
  int total=0;
  public int somar(int numeroUm, int numeroDois) {
      this.total = numeroUm + numeroDois;
      return total;
  }
}