Javadoc

Origem: Wikipdia, a enciclopdia livre. Ir para: navegao, pesquisa Javadoc um gerador de documentao criado pela Sun Microsystems para documentar a API dos programas em Java, a partir do cdigo-fonte. O resultado expresso em HTML. constitudo, basicamente, por algumas marcaes muitos simples inseridas nos comentrios do programa. Este sistema o padro de documentao de classes em Java, e muitas dos IDEs desta linguagem iro automaticamente gerar um Javadoc em HTML. Ele tambm prov uma API para a criao de doclets e taglets, que permitem a anlise da estrutura de um aplicativo Java. assim, por exemplo, que o JDiff consegue gerar relatrios de alteraes feitas entre duas verses de uma API.

ndice

1 Rodando Javadoc em Windows 2 Tags Javadoc 3 Exemplo 4 Ligaes externas

Rodando Javadoc em Windows

Para documentar todas as classes em um diretrio, rode a seguinte instruo na linha de comando (ou coloque-o em um arquivo BAT e execute-o). Dependendo do diretrio de instalao na sua mquina, voc dever usar a linha baixo modificada, mas ela ir criar um diretrio com a documentao de todas as suas classes:
"C:\Arquivos de programas\Java\jdk1.6.0\bin\javadoc" -d doc *.java

Por padro, apenas os membros pblicos so mostrados. Para ter uma visibilidade mais profunda, voc pode usar os seguintes modificadores:

-protected -package -private

Tags Javadoc
Os desenvolvedores usam certos estilos de comentrios e tags Javadoc ao documentar cdigos-fonte. Um bloco de comentrio em Java iniciado com /** ir iniciar um bloco de comentrio Javadoc, que ser includo no HTML gerado. Uma tag Javadoc comea com um "@" (arroba). Na tabela abaixo, algumas destas tags.

Tag @author

Descrio

Nome do desenvolvedor Marca o mtodo como deprecated. Algumas IDEs exibiro um @deprecated alerta de compilao se o mtodo for chamado. Documenta uma exceo lanada por um mtodo veja tambm @exception @throws. @param Define um parmetro do mtodo. Requerido para cada parmetro. Documenta o valor de retorno. Essa tag no deve ser usada para @return construtores ou mtodos definidos com o tipo de retorno void. @see Documenta uma associao a outro mtodo ou classe. @since Documenta quando o mtodo foi adicionado a a classe. Documenta uma exceo lanada por um mtodo. um sinnimo @throws para a @exception introduzida no Javadoc 1.2. @version Exibe o nmero da verso de uma classe ou um mtodo. Para inserir o smbolo @ sem iniciar uma tag Javadoc voc pode usar o cdigo de caracter HTML @ e evitar problemas de parsing.

Exemplo
Segue-se um exemplo de uso do Javadoc para documentar um mtodo. Note que o espaamento e a quantidade de caracteres neste exemplo apenas seguem as convenes.
/** * Valida um movimento de xadrez. * * @param aColunaDe Coluna atual da pea a ser movida * @param aLinhaDe Linha atual da pea a ser movida * @param aColunaPara Coluna destino da pea a ser movida * @param aLinhaPara Linha destino da pea a ser movida * @return verdadeiro se o movimento vlido ou falso se invlido * @author Joana Silva * @author Nuno Martins */ boolean validaMovimento(int aColunaDe, int aLinhaDe, int aColunaPara, int aLinhaPara) { ... }

Ligaes externas

Website do Javadoc (em ingls) Coleo de doclets Javadoc (em ingls) Motor de busca de Javadocs (em ingls)