Como gerar arquivos HTML Javadoc no Eclipse?

165

Escrevi comentários no estilo Javadoc como este no código do meu projeto:

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

Como posso gerar arquivos HTML Javadoc usando o Eclipse IDE?

java eclipse javadoc

— JaneNY
fonte

consulte isso. learnjava-soa.blogspot.com/2015/06/…

— madhu

234

Project> Generate Javadoc....
No Javadoc command:campo, procure o javadoc.exe (geralmente em [path_to_jdk_directory] \ bin \ javadoc.exe ).
Marque a caixa ao lado do projeto / pacote / arquivo para o qual você está criando o Javadoc.
No Destination:campo, procure o destino desejado (por exemplo, o diretório raiz do projeto atual).
Clique em Finish.

Agora você deve encontrar o Javadoc recém-gerado na pasta de destino. Abra index.html .

— Renu P
fonte

1

O Java JDK precisa ser instalado? Eu tenho o Java instalado e posso criar programas Java no Eclipse ... mas javadoc.exenão existe em nenhum lugar da minha unidade!

— precisa saber é

Antigo, mas para qualquer pessoa no futuro que possa estar confusa sobre isso, verifique se você possui o JDK instalado em oposição ao JRE (que não contém javadoc.exe neste local).

— Omoshiroiii 23/09/19

9

Esta é uma resposta complementar relacionada ao PO:

Uma solução fácil e confiável para adicionar comentários de Javadocs no Eclipse:

Vá para Help> Eclipse Marketplace....
Encontre "JAutodoc".
Instale-o e reinicie o Eclipse.

Para usar esta ferramenta, clique com o botão direito na classe e clique em JAutodoc.

— pioneerBhawna
fonte

7

AFAIK, JAutodoc não gera HTML a partir de comentários javadoc existentes (que é o que a pergunta pede), mas ajuda a gerar os comentários javadoc.

— Amani Kilumanga

3

Resposta não está relacionado com a questão, mas isso é o que eu estava exatamente procurando :)

— keya

O Eclipse permitirá que você gere Javadocs: Projeto -> Gerar Javadocs ...

— pongapundit

Isso irá gerar apenas o javadoc, não o html, que é a questão.

— Ashish

5

Você também pode fazer isso na linha de comando com muita facilidade.

Abra a linha de comando da pasta / pacote.
Na linha de comando, execute:

javadoc YourClassName.java
Para gerar em lote documentos para várias classes:

javadoc * .java

— Sean Das
fonte

2

Para adicionar rapidamente um Javadoc, use o seguinte atalho:

Windows : alt+ shift+J

Mac : ⌘+ Alt+J

Dependendo do contexto selecionado, um Javadoc será impresso. Para criar Javadoc escrito por OP, selecione o método correspondente e pressione as teclas de atalho.

— Jacob van Lingen
fonte