insertar - ¿Cómo generar Javadoc HTML en Eclipse?

javadoc command eclipse

Question

Escribí comentarios de estilo Javadoc como este en mi proyecto:

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

¿Cómo puedo generar Javadoc HTML desde Eclipse?

Answer 1

1. Proyecto > Generar Javadoc ....

2. En el campo Javadoc command: explore para encontrar javadoc.exe (normalmente en [path_to_jdk_directory] / bin / javadoc.exe ).

3. Marque la casilla junto al proyecto / paquete / archivo para el cual está creando el Javadoc.

4. En el campo Destino: busque el destino deseado (por ejemplo, el directorio raíz del proyecto actual).

5. Haga clic en Finalizar .

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

Answer 2

Para agregar rápidamente un uso de Javadoc siguiente atajo:

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 acceso directo.

Answer 3

Solución fácil y confiable para agregar Javadocs en Eclipse:

1. Vaya a Ayuda > Eclipse Marketplace ....
2. Encuentra "JAutodoc".
3. Instálalo y reinicia Eclipse.

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

Answer 4

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

1. Abra la línea de comando de la carpeta / paquete.

2. Desde la línea de comando ejecutar:

   javadoc YourClassName.java

3. Para generar documentos por lotes para múltiples clases:

   javadoc * .java

Answer 5

¿Cómo generar Javadoc en Eclipse?

1. Abra la carpeta del proyecto Eclipse.

2. Seleccione Proyecto > Generar Javadoc ....

3. En el primer paso del asistente, puede definir configuraciones para:

   3.1. Seleccione la ruta para la herramienta javadoc.exe desde el JDK.
   3.2. Recursos del proyecto para los cuales generar Javadoc.
   3.3. Clases y métodos para generar Javadoc en función de su visibilidad.
   3.4. Ubicación del Javadoc (por defecto se colocará en la carpeta doc en la ubicación del proyecto).

4. En el segundo paso, puede realizar configuraciones relacionadas con:

   4.1. Titulo del documento.
   4.2. Estructura de documentación.
   4.3. Seleccione etiquetas de documentos para ser procesadas.
   4.4. Otros recursos (archivos, proyectos) utilizados en el proyecto para ser incluidos en la documentación.
   4.5. Seleccione la hoja de estilo CSS para su documentación.

5. En el último paso, puede guardar las configuraciones en un script Ant para usarlas en el futuro.