@Documented

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

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

  1. 创建一个自定义注解。在项目的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文档中。

  1. 使用自定义注解。在需要使用自定义注解的地方,例如一个类上,示例如下:
@MyAnnotation("My custom annotation")
public class MyClass {
    // 类的具体实现
}

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

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

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

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

123的故事

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值