Wilson357

13:55

JavaDoc - Básico do básico * (n!)^n





Faz tempo que quero aprender java, mas nunca me sobra tempo. Porém, agora estou iniciando a aprendizagem.
Nesse percurso aprendemos diversas coisas "chatas", difíceis de decorar. Uma delas é a linha de comando para gerar a documentação dos fontes.
Aqui, para relembrar sempre, vai um script (muito mal feito, reconheço minha preguiça) para gerar a documentação:

#!/bin/bash

javadoc -private -d ./doc/ -use -version -author -docfilessubdirs -charset UTF-8 *.java


Um bom lugar para começar é com o link: http://pt.wikipedia.org/wiki/Javadoc
Uma descrição mais detalhada pode ser encontrada em: http://download.oracle.com/javase/1.5.0/docs/tooldocs/solaris/javadoc.html

Parâmetros usados no comando javadoc:
-private: O javadoc documenta classes que são públicas, porém é possível documentar as privadas e protegidas.
-d : Especifica o diretório onde será gerado os documentos.
./doc/ : Diretório. Parâmetro do argumento anterior.
-use : Instrui o uso das classes e pacotes.
-Version: Versão do documento, especificado com o @version, nos comentários.
-Author: Author do fonte, especificado com o @author, nos comentários.
-docfilessubdir: verifica os fontes nos subdiretórios.
-charset: Codificação do HTML.
UTF-8: Especifica que o html deve ser codificado com a tabela UTF-8. Assim, a palavra "Número", por exemplo, aparecerá escrita corretamente acentuada.
*.java: Especifica que todos os '.java' serão gerados no documento.

---
Muito bacana isso XD

Completando este post, quero postar o link de outros geradores de documentação. De todos que encontrei, este foi o mais bacana:
http://www.stack.nl/~dimitri/doxygen/docblocks.html

Além de gerar a documentação em um layout mais "suave" e podendo personalizar o layout de acordo com um xml, ele gera a imagem UML das classes:

O único problema que encontrei, e ainda não solucionei, foi que ele gera documentação de java no estilo C/C++, ou seja, propriedades de classe são referenciadas como: Classe::ClasseMembro(parametros)

Isso não é problema pra mim, visto que gosto mais assim mesmo kkkkk, mas irei buscar no helper a forma correta de compilar a documentação em java, visto que o dOxygen gera documentação pra Python, PHP, etc, em diversos formatos.

2 comentários:

Anônimo disse...

teste

Anônimo disse...

outro teste