Cómo utilizar el comando javadoc para generar documentación de API y comentarios de documentación

Utilice el comando javadoc para generar documentación de API:

Cree un paquete de archivos fuente de Java. Los archivos Java se almacenan en un paquete. Para facilitar la operación y distinción de los archivos Java, primero debe crear una carpeta en el disco de la misma manera que se crea un paquete.

Crear archivos fuente java. Cree un archivo fuente de Java con el mismo nombre que el archivo en el paquete de software e ingrese algunos comentarios de documentación. Estos comentarios de documentación se utilizan para explicar el archivo API automático.

Ingrese el directorio del archivo fuente de Java. Utilice un comando de Windows como cd para ingresar la ubicación del disco donde se encuentra el paquete de código fuente de Java.

Vea las instrucciones para usar el comando javadoc. Si es la primera vez que utiliza el comando javadoc, puede utilizar el comando javadoc -help para ver las instrucciones de uso de javadoc.

Comienza a crear el archivo api. Utilice el comando enter javadoc -d javaapi -header API para probar -doctitle Este es mi primer comentario de documentación -version -author javadoc/Hello.java para generar documentación. -d: ubicación de almacenamiento del archivo; -head: nombre del encabezado del archivo; -version: versión de visualización; -autor: javadoc/Hello.java procesa paquetes de documentos y archivos fuente de Java.

Ver el archivo api generado. Después de una creación exitosa, creará automáticamente la carpeta especificada en el archivo API generado. El index.html abierto es el punto de entrada del archivo api.