¿Qué es la herramienta JavaDoc y cómo usarla?

La herramienta JavaDoc es una herramienta generadora de documentos en el lenguaje de programación Java para generar documentación estándar en formato HTML. Genera documentación API . Analiza la documentación de anuncios de declaraciones en un conjunto de archivos fuente que describen clases, métodos, constructores y campos.

Antes de usar la herramienta JavaDoc, debe incluir comentarios de JavaDoc /**………………..*/ proporcionando información sobre clases, métodos y constructores, etc. Para crear una API de documento buena y comprensible para cualquier archivo java, debe escribir mejores comentarios para cada clase, método, constructor.

Los comentarios de JavaDoc son diferentes de los comentarios normales debido al asterisco adicional al principio del comentario. También puede contener las etiquetas HTML . 

// Single-Line Comment

/* 
* Multiple-Line comment
*/

/** 
* JavaDoc comment
*/

Escribir varios comentarios no afecta el rendimiento del programa Java, ya que todos los comentarios se eliminan en el momento de la compilación.

Formato JavaDoc: – 
Tiene dos partes: – una descripción seguida de etiquetas de bloque.
Algunos entornos de desarrollo integrado (IDE) generan automáticamente el archivo JavaDoc como NetBeans, IntelliJ IDEA, Eclipse, etc.

Generación de JavaDoc: – 
Para crear un JavaDoc no es necesario compilar el archivo java. Para crear la API de documentación de Java, debe escribir Javadoc seguido del nombre del archivo. 

javadoc file_name or javadoc package_name

Después de la ejecución exitosa del comando anterior, se crearán varios archivos HTML, abra el archivo llamado índice para ver toda la información sobre las clases.

Etiquetas JavaDoc 
 

Para generar JavaDoc en Eclipse: – 

• Seleccione la opción «Generar JavaDoc» del menú Proyecto y aparecerá un asistente.
• Especifique la ubicación del archivo JavaDoc en su computadora, por defecto estará en la unidad C.
• Seleccione el proyecto y luego los paquetes para los que desea crear el archivo JavaDoc.
• Después de esto, en el lado derecho, seleccione las clases para las que desea generar el JavaDoc, por defecto se seleccionarán todas las clases.
• Luego, también puede especificar para qué clases se generará el JavaDoc seleccionando la visibilidad.
• Seleccione la ubicación de destino donde se colocará el JavaDoc generado.
• Luego haga clic en Siguiente o Finalizar. 
  Si selecciona Siguiente en la siguiente ventana, puede seleccionar el título del documento y otras opciones básicas. 
   

Ejemplo 1: –  

package exa;
  
import java.util.Scanner;
  
/**
*
* @author Yash
*/
public class Example {
    /**
* This is a program for adding two numbers in java.
    * @param args
*/
    public static void main(String[] args)
    {
        /**
        * This is the main method 
        * which is very important for 
        * execution for a java program.
        */
  
        int x, y;
        Scanner sc = new Scanner(System.in);
        /**
        * Declared two variables x and y. 
        * And taking input from the user 
        * by using Scanner class. 
        *
        */
  
        x = sc.nextInt();
        y = sc.nextInt();
        /**
        * Storing the result in variable sum 
        * which is of the integer type.
        */
        int sum = x + y;
  
        /**
        * Using standard output stream 
        * for giving the output.
        * @return null
        */
        System.out.println("Sum is: " + sum);
    }
}

Generando documento para la clase anterior 

javadoc exa

Captura de pantalla de javadoc: –