A documentação é uma das coisas mais importantes que você pode adicionar ao escrever código de programação. Documentar seu programa adicionando comentários ao seu código vai ajudar os outros a entender o que cada seção do código é suposto para realizar dentro de seu programa. Mesmo se você estiver escrevendo código que ninguém vai ler, os comentários podem ajudá-lo a lembrar o que você estava fazendo quando você olha para um programa que você escreveu meses ou anos no passado. Existem dois métodos de inserção de comentários em seu programa Java.
Coisas que você precisa
- Editor de texto
Única linha Comentários
Abra o seu editor de texto. Introduza os dois caracteres de barra no início de uma linha de texto.
Digite o seu comentário imediatamente após as duas barras. Seu comentário deve ter esta aparência:
// Este é um exemplo de uma única linha de comentário.
Termine o comentário pressionando a tecla Enter no teclado. A chave de entrada será automaticamente terminar o comentário. execução de código será retomada na próxima linha.
Multi-Line Comentários
Insira uma barra seguida de um asterisco.
Digite o seu comentário em qualquer lugar após o asterisco.
No final do seu comentário, digite um asterisco, seguido de um caractere de barra. O seu comentário será parecido com este:
/ *
Este é um comentário que
se estende por várias linhas.
Este comentário pode ser tão longo como você
gostaria de fazer isso.
* /
dicas & avisos
- Os caracteres que delimitam para comentários multi-linha também pode ser usado para comentários de linha única. Por exemplo: / * isto é um comentário válido * /
- comentários de linha única pode ser usado em série para abranger várias linhas.
- // Esses são
- // Também válida
- // comentários.
- Você também pode usar os comentários para depurar seu código temporariamente comentar uma linha questionável ou seção de código durante a execução do teste.