Como usar comentários em programação java
Video: Tutorial Java Aula 7- Comentários e Javadoc
Conteúdo
Na programação Java, há uma diferença entre o código escrito apenas para máquinas e código escrito para ser lido por pessoas. Esta primeira listagem é muito simples e é destinado apenas para máquinas.
Video: Java - Aula 3 - Usando a classe JOptionPane
pacote de classe org.allyourcode.myfirstproject-pública MyFirstJavaClass {/ *** args @param * / public static void main (String [] args) {javax.swing.JOptionPane.showMessageDialog (null, "Olá") -}}Esta segunda lista tem uma versão melhorada do código na primeira listagem. Além de todas as expressões, identificadores, e pontuação, esta segunda lista tem o texto que significou para os seres humanos a ler.
/ ** Listagem 5-2 em * "Java para desenvolvedores Android For Dummies"** de Copyright 2013 Wiley Publishing, Inc. * Todos os direitos reservados. * /org.allyourcode.myfirstproject- pacote/ *** MyFirstJavaClass exibe uma caixa de diálogo * na tela do computador. ** @author Barry Burd * @version 1.0 02/02/13 * @see java.swing.JOptionPane * /MyFirstJavaClass classe pública { / *** O ponto de execução de partida. ** args @param * (Não usado.) * /void main (String [] args) public static {javax.swing.JOptionPane.showMessageDialog (NULL, "Olá") - //nulo?}}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: Tudo entre a abertura / * e o fechamento * / é apenas para os olhos humanos.
Linhas 2-6 na segunda lista tem asteriscos extras (*). Eles são extra porque esses asteriscos não são necessários quando você cria um comentário. Eles só fazer o comentário bonita. Eles estão incluídos na lista porque, por algum motivo, a maioria dos programadores Java insistem em adicionar estes asteriscos extras.
Fim-de-line comentários: O texto //nulo? na segunda lista é um fim da linha comentar - ele começa com duas barras e vai até o final de uma linha de tipo. Mais uma vez, o compilador não traduzir o texto dentro de um comentário de fim de linha.
comentários Javadoc: UMA javadoc comentário começa com uma barra e dois asteriscos (/ **). A segunda lista tem dois comentários javadoc - um com o texto MyFirstJavaClass exibe uma caixa de diálogo. . . e outro com o texto O ponto de partida. . . .
Video: Aula de Java 002 - Comentários
UMA javadoc comentário é um tipo especial de comentário tradicional: É feito para ser lido por pessoas que nunca sequer olhar para o código Java.
Espera - que não faz sentido. Como você pode ver os comentários javadoc na listagem se você nunca olhar para a lista?
Bem, com alguns pontos e cliques, você pode encontrar todos os comentários Javadoc na segunda lista e transformá-los em uma página web de boa aparência, como mostrado na figura.
Para tornar as páginas de documentação para o seu próprio código, siga estes passos:
Coloque comentários Javadoc em seu código.
A partir do menu principal em Eclipse, escolha Project → Gerar Javadoc.
Como resultado, a caixa de diálogo Javadoc Geração aparece.
Na caixa de diálogo Javadoc Generation, selecione o projeto Eclipse cujo código que deseja documentar.
Ainda na caixa de diálogo Javadoc Generation, observe o nome da pasta no campo Destino.
Video: Java - Aula 1 - Instalação e Apresentação do IDE
O computador coloca as páginas de documentação recém-criados nessa pasta. Se preferir uma pasta diferente, você pode alterar o nome da pasta neste campo Destino.
Clique em Concluir.
Como resultado, o computador cria as páginas de documentação.
Se você visitar a pasta de destino e clique duas vezes no novo index.html ícone do arquivo, você verá seus belos (e informativas) páginas de documentação.
Você pode encontrar as páginas de documentação para as classes API built-in do Java, visitando o site da Oracle Documentação Java SE at a Glance página. API do Java contém milhares de aulas, por isso não memorizar os nomes das classes e seus métodos. Em vez disso, você simplesmente visitar estas páginas de documentação on-line.