Como gerar javadoc no Eclipse

Javadoc é um recurso de documentação automática a partir de informações contidas no código fonte de classes Java. Veja como gerar o javadoc no Eclipse (...)

Autor: Rita Cury

Por Rita Cury

Javadoc é um recurso criado pela Sun, com objetivo de gerar documentação automaticamente a partir de informações contidas no código fonte de classes Java.

Em desenvolvimento de software, a documentação é algo fundamental para permitir que programadores envolvidos direta ou indiretamente no projeto tenham referência acerca do mesmo e possam entender os códigos e usar suas funcionalidades de maneira correta.

O objetivo deste artigo é mostrar o passo-a-passo para gerar javadoc no Eclipse.

Para isto, criamos o projeto Empresa, dentro do qual inserimos opackagebr.com.impacta.comercial e dentro deste pacote,  a classe Cliente.

Nossa classe Cliente, é composta pelos atributos nome, dataNascimento e endereco; métodos getters e setters e construtor padrão.

Para gerar o javadoc, é necessário criarmos os comentários que farão parte da documentação, seguindo as seguintes regras:

  • Os comentários devem ser digitados entre /** */
  • Usar as marcações corretas de acordo com o objetivo da documentação. Por exemplo, a marcação que define autor é @author

A seguir, trecho de código da classe Cliente, devidamente preparada para que o javadoc seja gerado:

captura blog

Capturar blog

Gerar o javadoc é a última etapa do processo. Ou seja, depois de ter escrito e definido todas as classes do projeto, siga os passos a seguir para gerar o javadoc pelo Eclipse.

1. No menu Project, escolha GenerateJavadoc…

2. Na caixa de diálogo Generate Javadoc, preencha o campo Javadoccommand, com o path do comando javadoc, que está dentro do diretório bin, onde o jdk foi instalado. Exemplo: C:Program FilesJavajdk1.6.0_21binjavadoc.exe

3. Para isto, clique no botão Configure, à direita, e procure pelo jdk, conforme figura a seguir:

4. Depois de preenchido o campo Javadoccommand, clique em Finish.

5. O javadoc será criado e o console apresentará uma saída como mostra a figura a seguir:

6. Para ver os arquivos html gerados, vá no Windows Explorer e procure pelo local onde salvou seu projeto Empresa, conforme figura a seguir:

Aprenda mais: Saiba como usar o método toString em Java

Você está cansado de explicar Java para seus amigos?
Então indique a um amigo o Guia Básico de Programação em Java: 

Baixe o e-Book e aprenda com o Guia Básico de Programação em Java

Compartilhe com seus contatos no Facebook, Twitter ou LinkedIN!

1 Comentário

    Deixe o seu comentário!

    Não perca nenhum post!