栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

@Documented注解的作用

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

@Documented注解的作用

许多注解头部都有@documented注解,例如jdk中自带的@Deprecated注解,路径是:java/lang/Deprecated.java,头部就含有这个注解。

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

看看@documented的源码

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

那么@documented的作用是什么?

如果一个注解@B,被@documented标注,那么被@B修饰的类,生成文档时,会显示@B。如果@B没有被@documented标准,最终生成的文档中就不会显示@B。
看一些文档示例:

  • 下面的图片中,类documentedAnnotationTest的上方有@MydocumentedAnnotation注解。具体代码看:Java @documented IDEA生成文档

  • 下图中,是没有加documented元注解,所以最终的文档里面,并没有显示注解@B。具体代码,看博客:java 注解示例(@documented)

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/309616.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号