Como se gera um JavaDoc no Eclipse

Programação Java
#1

Alguém pode me ajudar a criar um JavaDoc no Eclipse.
Como faço e pra que serve?
Gostaria de explicações escuto falar disso por aí.

Abraços e Obrigado!

#2

Opa!

Javadocs servem para vc documentar suas APIs… Com ele vc gera documentacoes igual as da API do J2SE por exemplo!

Vc deve colocar sobre o sua funcao/classe/qualquer outra coisa a marcação de javadoc referente a mesma

Tipo:

         /**
         * Funcao de Teste
         *@param parametro
         *@return qualquer coisa
         */
         public String Teste(String parametro){
                  return "aaaa";
         }

Para gerar no Eclipse, vah em Project->Generate Javadoc

Mais informcacoes em: http://java.sun.com/j2se/javadoc/writingdoccomments/

#3

Just like magic

  1. Declare a sua função.
public String funcao (int parametro1, String parametro2) throws IOException {
}

Deixe uma linha em branco antes de sua função.
2) Nessa linha em branco, digite /** e então tecle Enter.
Deve aparecer algo como:

/**
 * @param parametro1
 * @param parametro2
 * @return 
 * @throws IOException
 */
public String funcao (int parametro1, String parametro2) throws IOException {
}

Uma vez que ele fez isso, agora é sua vez. Inclua a descrição da função, e uma descrição de cada um dos parâmetros. NÂO inclua o tipo do parâmetro, ou de retorno, já que isso está escrito explicitamente na declaração do método. Pode ser algo como:

/**
 * Destrambulador de rebimboca da parafuseta.
 * @param parametro1 Número de rebimbocas.
 * @param parametro2 Descrição da parafuseta.
 * @return Mensagem do destrambulador.
 * @throws IOException Quando a parafuseta não encontra a rebimboca.
 */

Agora você pode ir ao menu Project e escolher Generate Javadoc, isso irá criar páginas HTML iguaizinhas às do Javadoc do JDK.

#4

E o pior q ainda tem gente que não usa Eclipse! :?

#5

Valeu pessoal, entendi…
Muito legal.
Muito obrigado!
Abraçosss

#6

Estou tentando gerar aqui uma documentação em html utilizando o javadoc, mas as palavras acentuadas estão aparecendo com formatações diferentes das do código (por exemplo, representação fica representação). o locale que estou utilizando no sistema (linux) é pt_BR.UTF-8. Os arquivos .java foram criados no Eclipse, utilizando o encoding Default (UTF-8). Se alguém já passou por esse problema e conseguiu solucionar, por favor.

#7