Programação  
 
Conhecimento computador >> Programação >> Programação em Java >> 
Como criar Javadoc ao comentar
Javadoc é o padrão de fato para a geração de documentação a partir do código fonte . É uma ferramenta para criar documentação HTML comentários especialmente formatados em código Java. Isso pode ser usado para gerar interface de programação de aplicação estruturada (API) documentação automaticamente , dar algumas dicas para o IDE ou para atribuição de pacotes, classes e métodos . Essencialmente, é uma maneira de comentar descrições de parâmetros , que escreveu o quê, e quem é a culpa em caso de quebra . Java vem com o programa de linha de comando javadoc para gerar a documentação HTML, mas a maioria dos ambientes de desenvolvimento integrado Java (IDEs) também têm esse integrado. Instruções
1

Criar comentários especiais javadoc . Para denotar um comentário javadoc , começar o comentário com /** . Comentários Javadoc normalmente existem no topo de um arquivo, antes das aulas e antes de métodos. Uma vez que é projetado para documentação da API completa , não é incomum ver os arquivos com mais comentários javadoc do que o código . "" /*** Este é um comentário javadoc . Ele não tem nenhum javadoc meta-tags ainda, mas se acionar o analisador javadoc para dar uma olhada neste comentário. * /" "
2

Adicione API meta-tags (etiquetas que descrevem a própria API ) ao comentar . Tags de API são os nomes dos parâmetros , descrições, perfis de exceção , descrições valor de retorno, nomes de métodos e descrições dos métodos. Muitos IDEs incorporar esses dados em suas dicas de ferramentas e outros ajudantes , bem como que seja para uso em HTML ou formulário de comentário.
3

Use a descrição do método. Esta meta -tag não tem nome tag: É simplesmente o comentário que vem antes das outras tags "" /*** Calcula a inclinação de uma linha . . * /" "
4

Incorporar descrições de parâmetros . Estes são indicados pelos meta-tags @ param , que devem ser seguidos por um nome de parâmetro e descrição " . " /*** Calcula a inclinação de uma linha . ** @ Param p1 Primeiro ponto que descreve a linha * @ param p2 Segundo ponto que descreve a linha * /" "
5

Retornar descrições de valor. Isso é indicado pela meta- tag @ return e deve ser seguido por uma descrição do valor de retorno. "" /*** Calcula a inclinação de uma linha . ** @ Param p1 Primeiro ponto que descreve a linha * @ param p2 Segundo ponto que descreve a linha * @ return Inclinação da linha como um float * /" "
6

Adicionar marcas de atribuição . As tags atribuem o código para um autor específico. "" /*** Calcula a inclinação de uma linha . ** @ Autor Jack Smith * @ param p1 Primeiro ponto que descreve a linha * @ param p2 Segundo ponto que descreve o Slope linha * @ return da linha como um float * /" "
7

gerar a documentação HTML. Se você não está usando um IDE ou você só quer fazer isso manualmente, você pode executar o programa de linha de comando javadoc do seu diretório do projeto. Especifique o diretório de saída com a opção- d e passá-lo uma lista de arquivos . Java (geralmente como um coringa ) . " " Docs javadoc -d * . Java ""

< br >

Anterior :

Próximo : No
  Os artigos relacionados
·Como criar Widgets interativos para o Android 
·Como formatar strings em Java Sintaxe Básica 
·Como Usar a caixa de combinação com Netbeans GUI 
·Definição de Java e Javascript 
·Como determinar o número total de ocorrências de cada…
·Como criar dois botões em Java 
·Como criar documento XML usando JDOM 
·Como usar o Infinito em Java 
·Como verificar status da impressora usando Java 
·Como fazer um proxy em Java 
  Artigos em destaque
·Protocolos Eyecatcher 
·Como adicionar texto em um JTextField 
·Como incluir um arquivo em um JSP 
·Por que usar um baixo nível de programação Linguagem…
·Limites do Eixo em MATLAB 
·Como teste para automação móvel 
·Tutorial para a API PhoneGap Camera 
·Como adicionar um ícone do site para a barra de endere…
·Como ativar o Java em um Smartphone 
·Definição de tinta persistente 
Cop e direita © Conhecimento computador http://ptcomputador.com Todos os Direitos Reservados