Páginas

Cómo generar Javadoc con autor y versión en Windows (paso a paso)



En este post te muestro cómo generar la documentación HTML de tu proyecto Java usando javadoc

, y en especial cómo incluir la información de Author y Version usando las opciones apropiadas.

¿Por qué usar javadoc?

javadoc genera documentación navegable en HTML a partir de los comentarios tipo Javadoc (/** ... */) en tus clases y métodos. Es muy útil para proyectos y para compartir APIs.

Requisitos previos

  • Tener instalado el JDK (no basta el JRE).
  • Asegúrate de que la carpeta .../jdk-XX/bin esté en tu PATH para que javadoc sea reconocido en CMD.

Comprobar instalación

java -version
javac -version
javadoc -version

Si javadoc da error como "no se reconoce como un comando...", agrega la ruta C:\Program Files\Java\jdk-XX\bin a la variable de entorno Path y abre un CMD nuevo.

Ejemplo de clase con Javadoc

Guarda esto en Javatest.java (o tu clase) antes de generar la doc:

/**
 * Clase principal de prueba para el proyecto.
 *
 * @author Shayla
 * @version 1.0
 * @since 2025
 */
package com.mycompany.javatest;

public class Javatest {
    /**
     * Método principal que inicia el programa.
     *
     * @param args argumentos desde la consola
     */
    public static void main(String[] args) {
        System.out.println("hello world");
    }
}

Comando para generar la documentación (incluyendo Author y Version)

Ejecuta desde la carpeta donde está Javatest.java:

javadoc -d doc -author -version Javatest.java
  • -d doc → crea la carpeta doc con los HTML.
  • -author → fuerza a incluir la sección Author (necesario en versiones recientes de JDK).
  • -version → muestra la etiqueta @version si la tienes.

Si tu clase está dentro de un paquete y tienes varios archivos en src, puedes generar la doc para todo el paquete:

javadoc -d doc -author -version -sourcepath src com.mycompany.javatest

Opcional: portada (overview)

Si quieres que tu nombre o descripción aparezcan en la página inicial de la documentación, crea un overview.html simple:

<html>
  <body>
    <h1>Proyecto Javatest</h1>
    <p>Documentación generada por Shayla</p>
  </body>
</html>

Y genera la doc con:

javadoc -d doc -overview overview.html -author -version Javatest.java

Ver la documentación

  1. Abre la carpeta doc generada.
  2. Haz doble clic en index.html para abrir en el navegador.
  3. Entra en la página de la clase (Javatest) y deberías ver Author: Shayla y la sección Since: o Version: si la añadiste.

Problemas comunes

  • No aparece el Author: usa la opción -author al generar la doc (las versiones recientes de JDK no lo muestran por defecto).
  • javadoc no reconocido: agrega la ruta jdk.../bin al PATH y abre un nuevo CMD.
  • Clases en paquetes: asegúrate de usar -sourcepath y el nombre del paquete si quieres documentar toda la estructura.
Labels: