Java 中怎么使用 @Documented 和 @Inherited 元注解控制注解的文档与继承性

胖雪大大_2329

胖雪大大_2329

2026-08-17

920人浏览

原创

@documented使注解出现在javadoc中,提升api可读性;@inherited使类级注解被子类继承,仅适用于type且不作用于方法、字段等。二者职责分离,可组合使用但互不影响。

java 中怎么使用 @documented 和 @inherited 元注解控制注解的文档与继承性

@Documented 和 @Inherited 是 Java 中两个功能明确、互不干扰的元注解,它们分别控制注解是否出现在 Javadoc 文档中、以及类级注解能否被子类自动继承。用错或忽略它们,容易导致文档缺失或继承行为不符合预期。

@Documented:让注解“写进文档里”

加上 @Documented 后,Javadoc 工具在生成 API 文档时,会把被标注的注解本身也一并展示出来。这对团队协作和接口可读性很关键——别人看文档就能立刻知道某个类或方法被打了什么语义标签。

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 它只影响文档生成,不改变运行逻辑,也不影响反射获取
  • 适合用于有业务含义的注解,比如 @ApiVersion("v2")、@Experimental、@DeprecatedSince("2026.1")
  • 如果自定义注解没加 @Documented,即使用了,Javadoc 默认不会显示该注解名称和参数值
  • 示例:@Documented @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME)
    public @interface Loggable { String value() default ""; }

@Inherited:让类级注解“传给子类”

@Inherited 只对标注在 类 上的注解生效,且仅作用于类的继承关系(即子类 extends 父类),不适用于接口实现、方法、字段或参数。

  • 它不改变注解本身的定义,只是开启“继承传播”开关
  • 典型场景是统一基类策略,比如父类加了 @Secured,所有子类自动具备安全校验能力
  • 注意:方法上的注解(如 @Override)不会被继承;@Inherited 对 METHOD、FIELD 等 ElementType 无效
  • 示例:@Inherited @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME)
    public @interface SecuredBase { }

组合使用时的关键细节

两者可以同时出现,但职责完全分离:一个管“人看不看得见”,一个管“子类有没有”。实际开发中常见组合如下:

  • 面向公共 API 的注解,建议同时加 @Documented + @Retention(RUNTIME),便于文档查阅和运行时处理
  • 需要子类自动继承的策略型注解,必须加 @Inherited,并确保只用于 TYPE(类/接口/枚举)
  • @Inherited 不会跨模块或跨 jar 生效——子类和父类需在同一个类加载器上下文才可靠
  • 不要误以为加了 @Inherited 就能“继承方法上的注解”,这是常见误解

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9577

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6722

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5972

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1044

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

868

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1256

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2509

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19851

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1135

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习