Criando Javadoc para Package no Eclipse

Serei rápido nesse tópico. Javadoc é a documentação do Java que pode ser utilizada para Atributos, Annotations, Interfaces, Classes, Pacotes, etc. Por default, o eclipse não oferece recursos para criar javadoc para os pacotes. Vamos mostrar aqui como definir Javadoc para os pacotes de uma aplicação.

 

Baixar plugin

No site http://sourceforge.net/projects/package-javadoc/ nós podemos baixar o plugin do eclipse para tal atividade.

 

Como instalar

Descompacte o pacote net.sf.packagedoc_1_0.zip e, com o ecplise fechado, copie a pasta plugins (que estava dentro do ZIP) para dentro da pasta do eclipse. Na pasta do eclipse, também existe uma pasta chamada plugins, portanto, quando o sistema perguntar, você deverá sobrescrevê-la. A próxima vez que você abrir o eclipse, o plugin já estará instalado.

 

Como utilizar

Dentro de seu projeto Java no eclipse, clique com o botão direito sobre um pacote, selecione a opção 'new', 'other...'.

Dentro da aba 'Java', selecione a opção 'Package Javadoc Page' e clique em 'Next'. Em 'Description' defina o texto do pacote.

Por exemplo:

 

Esse pacote possui classes para tal e tal e tal. Colque aqui os textos que ajudam o programador a usar os recursos contidos no pacote, indicações sobre o desenvolvedor e etc.

  

Bom é isso.

Obrigado pela rápida leitura.

Até a próxima.