El papel de la anotación @Documentada

¿ Dónde se @Documentedutilizan las anotaciones?

@DocumentedEs una meta-anotación que puede modificar otras anotaciones. Muchos encabezados de anotaciones tienen @Documentedanotaciones, como las anotaciones que vienen con jdk @Deprecated(la ruta es: java/lang/Deprecated.java) El encabezado contiene esta anotación:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={
    
    CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
    
    
}

Mira @Documentedel código fuente

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
    
    
}

Entonces, ¿cuál es el papel de @Documented?

Si se anota una anotación @B, @Documentedla @Bclase modificada se mostrará al generar la documentación @B. Si @Bno está @Documentednormalizado, no aparecerá en la documentación final generada @B.
Veamos algunos ejemplos de documentación:

• En la imagen a continuación, hay anotaciones DocumentedAnnotationTestsobre la clase, que se modifican. Ver el código específico: Java @Documented IDEA genera documentos@MyDocumentedAnnotation@MyDocumentedAnnotation@Documented
  

• En la figura siguiente, MyTest2no se muestran comentarios porque @Bno se han Documentedmodificado, por lo que no se muestran comentarios en el documento final @B. Para obtener el código específico, consulte el blog: ejemplo de anotación de Java (@Documented)