Comentários Java: por que e como usá-los?

Neste tutorial, você aprenderá sobre os comentários Java, por que os usamos e como usar os comentários da maneira certa.

Na programação de computadores, os comentários são uma parte do programa completamente ignorada pelos compiladores Java. Eles são usados ​​principalmente para ajudar os programadores a entender o código. Por exemplo,

 // declare and initialize two variables int a =1; int b = 3; // print the output System.out.println("This is output"); 

Aqui, usamos os seguintes comentários,

  • declara e inicializa duas variáveis
  • imprimir a saída

Tipos de comentários em Java

Em Java, existem dois tipos de comentários:

  • comentário de linha única
  • comentário multilinha

Comentário de linha única

Um comentário de uma linha começa e termina na mesma linha. Para escrever um comentário de uma única linha, podemos usar o //símbolo. Por exemplo,

 // "Hello, World!" program example class Main ( public static void main(String() args) ( ( // prints "Hello, World!" System.out.println("Hello, World!"); ) ) 

Produto :

 Olá Mundo! 

Aqui, usamos dois comentários de linha única:

  • "Olá Mundo!" exemplo de programa
  • imprime "Hello World!"

O compilador Java ignora tudo, desde //o final da linha. Portanto, ele também é conhecido como comentário de fim de linha .

Comentário multilinha

Quando queremos escrever comentários em várias linhas, podemos usar o comentário multilinhas. Para escrever comentários de várias linhas, podemos usar o símbolo / *…. * /. Por exemplo,

 /* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ class HelloWorld ( public static void main(String() args) ( ( System.out.println("Hello, World!"); ) ) 

Produto :

 Olá Mundo! 

Aqui, usamos o comentário de várias linhas:

 /* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ 

Esse tipo de comentário também é conhecido como Comentário Tradicional . Nesse tipo de comentário, o compilador Java ignora tudo de /*a */.

Use os comentários da maneira certa

Uma coisa que você sempre deve considerar é que os comentários não devem ser o substituto de uma maneira de explicar códigos mal escritos em inglês. Você deve sempre escrever um código bem estruturado e autoexplicativo. E então use comentários.

Alguns acreditam que o código deve ser autodescritivo e os comentários raramente devem ser usados. No entanto, na minha opinião pessoal, não há nada de errado em usar comentários. Podemos usar comentários para explicar algoritmos complexos, regex ou cenários onde temos que escolher uma técnica entre diferentes técnicas para resolver problemas.

Nota : na maioria dos casos, sempre use comentários para explicar ' por que ' em vez de ' como ' e você está pronto para ir.

Artigos interessantes...