Comentários em Java

Comentários em Java , como na maioria das outras linguagens de programação, são caracteres ignorados durante a execução do programa. Assim, você pode adicionar quantos comentários forem necessários ao programa sem medo de aumentar seu tamanho. Os comentários são usados ​​para descrever as complexidades de um determinado bloco de código, método ou classe. Você também pode usá-los se quiser deixar mensagens para programadores que trabalharão com este código no futuro. Ou para suas próprias anotações.

Maneiras de destacar comentários

Java possui duas maneiras de destacar comentários no texto.

Comentário de implementação (comentário de código)

1. Comentando uma linha

   Este é o tipo de comentário mais comumente usado. Para escrever tal comentário, você precisa usar duas barras //. Neste caso, o comentário começa imediatamente após os caracteres //e continua até o final da linha.

   System.out.println("Hello, Java world!");
   // наш комментарий

2. Comentando um bloco de texto

   Se precisar de comentários mais longos, você pode iniciar cada linha com símbolos. Embora seja mais conveniente limitar os blocos de comentários aos delimitadores /*e */.

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

   Não devemos esquecer que comentários separados por símbolos /*não podem */ser aninhados na linguagem Java. Isso significa que um trecho de código não pode ser desabilitado simplesmente cercando-o com /*e , já que o próprio código sendo desabilitado pode conter */delimitadores /*e */.

Documentando comentário

Para documentar métodos, variáveis ​​ou classes, é utilizado um método especial de destaque de texto. Isso é feito usando /**e */. Neste caso, cada linha de texto comentado começa com *Se um método estiver documentado, é habitual descrever seus argumentos e valor de retorno.

/**
* Метод возвращает максимальное meaning
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

O que mais ler? Por exemplo, este material: Comentários em Java: nem tudo é tão simples . Ou uma palestra da missão Java Syntax Pro sobre comentários.