Java @anotaciones documentadas

De forma predeterminada, las anotaciones de Java no se muestran en la documentación creada con la herramienta Javadoc . Para garantizar que nuestras anotaciones personalizadas se muestren en la documentación, usamos la anotación @Documented para anotar nuestras anotaciones personalizadas. @Documentado es una metaanotación (una anotación aplicada a otras anotaciones) proporcionada en el paquete java.lang .annotation.

Casos:

1. Sin usar la anotación @Documentada
2. Usando la anotación @Documentada

Discutamos ambos escenarios con cierta profundidad. 

Caso 1: Sin utilizar la anotación @Documentada

En el ejemplo de código que se muestra a continuación, hemos creado una anotación personalizada llamada CustomAnnotation. Después de eso, hemos anotado nuestra clase llamada DocumentedAnnotationDemo con ella. Finalmente, creamos documentación utilizando la herramienta Javadoc. La sintaxis para usar la utilidad Javadoc en el símbolo del sistema se menciona a continuación.

javadoc NameOfClassFile.java

Ejemplo

// Java Program to Illustrate Documented Annotations
// Without using @Documented annotation
 
// Creating a single value custom annotation
@interface CustomAnnotation {
    String value();
}
 
@CustomAnnotation("GFG")
public class DocumentedAnnotationDemo {
    public static void main(String[] args) {
        System.out.println("This is the main method");
    }
}

This is the main method

Cuando creamos la documentación del ejemplo de código que se muestra arriba, la anotación personalizada utilizada para anotar nuestra clase DocumentedAnnotationDemo no se muestra en la documentación y se muestra en la instantánea que se muestra a continuación.

Documentación sin usar la anotación @Documented

Caso 2: Uso de la anotación @Documentada

En el ejemplo de código que se muestra a continuación, hemos vuelto a crear la misma anotación personalizada llamada CustomAnnotation, pero en este caso, usamos @Documented para anotar nuestra anotación personalizada. Después de eso, hemos anotado nuestra clase llamada DocumentedAnnotationDemo con ella. Finalmente, creamos documentación utilizando la herramienta Javadoc. 

Ejemplo

// Java Program to Illustrate Documented Annotations
// With using @Documented annotation
 
// Importing the Documented annotation
import java.lang.annotation.Documented;
 
// Creating a single value custom annotation
// which is annotated using @Documented
// annotation
@Documented @interface CustomAnnotation { String value(); }
 
// This annotation will be documented
@CustomAnnotation("GFG")
 
// Main class
public class GFG {
 
    // Main driver method
    public static void main(String[] args)
    {
 
        // Print and display statement on the console
        System.out.println("This is the main function");
    }
}

This is the main function

Cuando ahora creamos la documentación del ejemplo de código que se muestra arriba, la anotación personalizada utilizada para anotar nuestra clase DocumentedAnnotationDemo se muestra en la documentación debido al uso de la anotación @Documented al crearla. A continuación se muestra una instantánea de la documentación creada en este caso.

Documentación usando la anotación @Documented