Adicionando Comentários ao Código Java
Este anúncio Java tem uma versão melhorada de um programa de amostra. Além de todas as palavras-chave, identificadores e pontuação, ele tem o texto que significou para os seres humanos a ler.
/ ** Listagem 3-6 no "Java For Dummies, 6a edição" ** de Copyright 2014 Wiley Publishing, Inc. * Todos os direitos reservados. * // *** O Exibidor de classe exibe texto * na tela do computador. ** @ autor Barry Burd * @version 1,0 10/24 / 13 * @see java.lang.System * / Exibidor classe pública {/ *** o método principal é onde * execução do código começa. ** args @param (Veja capítulo . 11) * / public void main (args static String []) {System.out.println ( "Eu amo Java!") - // I? Você?}}UMA comente é uma seção especial do texto dentro de um programa cujo objetivo é ajudar as pessoas a entender o programa. Um comentário é parte da documentação de um bom programa.
A linguagem de programação Java tem três tipos de comentários:
Comentários tradicionais: As primeiras cinco linhas da forma perfil um tradicional comente. O comentário começa com / * e termina com * /. Tudo entre a abertura / * e o fechamento * / é apenas para os olhos humanos. Não há informações sobre "Java For Dummies, 6a edição" ou Wiley Publishing, Inc. é traduzido pelo compilador.
A segunda, terceira, quarta e quinta linhas na Listagem 3-6 tem asteriscos extras (*). Eles são chamados de extra porque estes asteriscos não são necessárias quando você cria um comentário. Eles simplesmente fazer o comentário bonita.
Fim-de-line comentários: O texto //EU? Você? na listagem é um fim da linha comente. Um comentário final-de-linha inicia-se com duas barras e vai para o fim de uma linha de texto. Mais uma vez, o compilador não traduzir o texto dentro do comentário de fim de linha.
comentários Javadoc: UMA javadoc comentário começa com uma barra e dois asteriscos (/ **). A listagem tem dois comentários Javadoc - um com o texto A classe Exibidor. . . e outro com o texto O método principal é onde. . . .
Um comentário javadoc é um tipo especial de comentário tradicional. Um comentário javadoc é feito para ser lido por pessoas que nunca sequer olhar para o código Java. Mas isso não faz sentido. Como você pode ver os comentários javadoc?
Bem, um determinado programa chamado javadoc (O que mais?) Pode encontrar todos os comentários Javadoc na lista e transformar esses comentários em uma página web de boa aparência. Esta figura mostra a página.
Javadoc comentários são grandes. Aqui estão algumas grandes coisas sobre eles:
A única pessoa que tem de olhar para um pedaço de código Java é o programador que escreve o código. Outras pessoas que usam o código pode descobrir o que o código faz visualizando a página web gerada automaticamente.
Porque outras pessoas não olhar para o código Java, outras pessoas não fazer alterações no código Java. (Em outras palavras, outras pessoas não introduzir erros no código Java existente.)
Porque outras pessoas não olhar para o código Java, outras pessoas não têm de decifrar o funcionamento interno do código Java. Todas essas pessoas precisam de saber sobre o código é o que lêem na página web do código.
O programador não cria duas coisas distintas - algum código Java aqui e alguma documentação sobre o código de lá. Em vez disso, o programador cria um pedaço de código Java e incorpora a documentação (sob a forma de comentários Javadoc) direito dentro do código.
O melhor de tudo, a geração de páginas web a partir comentários Javadoc é automática. Assim, a documentação de todos tem o mesmo formato. Não importa cujo código Java que você usa, você descobrir sobre esse código, lendo uma página como a da figura. Isso é bom porque o formato é familiar para quem usa Java.