Java @Documented 注释

默认情况下， Java注释不会显示在使用Javadoc 工具创建的文档中。为了确保我们的自定义注释显示在文档中，我们使用@Documented 注释来注释我们的自定义注释。 @Documented 是Java.lang.annotation 包中提供的元注解（应用于其他注解的注解）。

案例：

1. 不使用@Documented 注释
2. 使用@Documented 注释

让我们在一定深度上讨论这两种情况。

案例 1：不使用 @Documented 注解

在下面显示的代码示例中，我们创建了一个名为 CustomAnnotation 的自定义注释。之后，我们用它注释了名为 DocumentedAnnotationDemo 的类。最后，我们使用 Javadoc 工具创建了文档。下面提到了在命令提示符下使用 Javadoc 实用程序的语法。

javadoc NameOfClassFile.java

例子

Java

// 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

当我们为上面显示的代码示例创建文档时，用于注释 DocumentedAnnotationDemo 类的自定义注释未显示在文档中，并在下面显示的快照中进行了描述。

不使用@Documented 注释的文档

案例 2：使用 @Documented 注解

在下面显示的代码示例中，我们再次创建了名为 CustomAnnotation 的相同自定义注释，但在本例中，我们使用 @Documented 来注释我们的自定义注释。之后，我们用它注释了名为 DocumentedAnnotationDemo 的类。最后，我们使用 Javadoc 工具创建了文档。

例子

Java

// 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

当我们现在创建上面显示的代码示例的文档时，由于在创建时使用了 @Documented 注释，用于注释 DocumentedAnnotationDemo 类的自定义注释显示在文档中。在这种情况下创建的文档的快照如下所示。

使用@Documented 注释的文档