¿Cómo generar archivos HTML Javadoc en Eclipse?

165

He escrito comentarios de estilo Javadoc como este en el código de mi proyecto:

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

¿Cómo puedo generar archivos HTML Javadoc usando el IDE de Eclipse?

java eclipse javadoc

— JaneNY
fuente

referir esto. learnjava-soa.blogspot.com/2015/06/…

— madhu

234

Project> Generate Javadoc....
En el Javadoc command:campo, busque javadoc.exe (generalmente en [path_to_jdk_directory] \ bin \ javadoc.exe ).
Marque la casilla junto al proyecto / paquete / archivo para el que está creando el Javadoc.
En el Destination:campo, navegue para encontrar el destino deseado (por ejemplo, el directorio raíz del proyecto actual).
Haga clic Finish.

Ahora debería poder encontrar el Javadoc recién generado en la carpeta de destino. Abra index.html .

— Renu P
fuente

1

¿Se necesita instalar Java JDK? Tengo Java instalado y puedo crear programas Java en Eclipse ... ¡pero javadoc.exeno existe en ninguna parte de mi disco!

— AlainD

Anterior, pero para cualquier persona en el futuro que pueda estar confundida acerca de esto, verifique si tiene el JDK instalado en lugar del JRE (que no contiene javadoc.exe en esta ubicación).

— omoshiroiii

9

Esta es una respuesta complementaria relacionada con el OP:

Una solución fácil y confiable para agregar comentarios Javadocs en Eclipse:

Ir a Help>Eclipse Marketplace... .
Encuentra "JAutodoc".
Instálelo y reinicie Eclipse.

Para usar esta herramienta, haga clic derecho en la clase y haga clic en JAutodoc.

— pioneroBhawna
fuente

77

AFAIK, JAutodoc no genera HTML a partir de comentarios javadoc existentes (que es lo que pide la pregunta), sino que ayuda a generar los comentarios javadoc.

— Amani Kilumanga

3

La respuesta no está relacionada con la pregunta, pero esto es lo que estaba buscando exactamente :)

— keya

Eclipse le permitirá generar Javadocs: Proyecto -> Generar Javadocs ...

— pongapundit

Esto solo generará javadoc, no el html, que es de lo que se trata la pregunta.

— Ashish

5

También puede hacerlo desde la línea de comandos con mucha facilidad.

Abra la línea de comando desde la carpeta / paquete.
Desde la línea de comando:

javadoc YourClassName.java
Para generar documentos por lotes para múltiples clases:

javadoc * .java

— Sean Das
fuente

2

Para agregar rápidamente un Javadoc, use el siguiente acceso directo:

Windows : alt+ shift+J

Mac : ⌘+Alt +J

Dependiendo del contexto seleccionado, se imprimirá un Javadoc. Para crear Javadoc escrito por OP, seleccione el método correspondiente y presione las teclas de disparo.

— Jacob van Lingen
fuente