@Documented

123的故事

于 2023-07-29 10:00:00 发布

阅读量3.1k

点赞数 2

CC 4.0 BY-SA版权

文章标签： java

本文链接：https://blog.csdn.net/qq_41177135/article/details/131987299

@Documented注解用于使自定义注解在Java文档中可见，结合@Retention和@Target使用，例如在@MyAnnotation中，确保被此注解标记的类如MyClass在生成的文档中展示其注解信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

@Documented注解是一个标记注解，用于指示将被注解的元素包含在生成的Java文档中。它本身没有任何属性或配置选项。通常情况下，@Documented注解应用于其他自定义注解，以确保其注解信息能够在生成的文档中显示。

下面是一个示例代码，以说明@Documented注解的配置及使用方法：

创建一个自定义注解。在项目的src/main/java目录下创建一个注解接口，例如@MyAnnotation.java，代码如下：

import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyAnnotation {
    String value() default "";
}

在上述代码中，@MyAnnotation注解应用了@Documented注解，表示被@MyAnnotation注解标记的元素将被包含在生成的Java文档中。

使用自定义注解。在需要使用自定义注解的地方，例如一个类上，示例如下：

@MyAnnotation("My custom annotation")
public class MyClass {
    // 类的具体实现
}

在上述代码中，使用@MyAnnotation注解标记了MyClass类。该注解的value属性被设置为"My custom annotation"，表示对该类的注解信息。

生成Java文档。使用工具（如javadoc）生成Java文档时，被@MyAnnotation注解标记的元素将会包含在生成的文档中。可以查看生成的文档，以验证@Documented注解的效果。

以上就是@Documented注解的配置和使用方法的示例代码。需要注意的是，@Documented注解本身没有配置选项，它的作用是指示被注解的元素在生成的Java文档中可见。