讲师中心 微信公众号
AI工具推荐 视频效率加速

Documented注解在生成Javadoc文档中的标记作用

夏杰同学_7985

夏杰同学_7985

发布时间:2026-03-26 09:56:04

|

955人浏览过

|

来源于php中文网

原创

@Documented 是一个元注解,用于使自定义注解出现在 Javadoc 生成的 HTML 文档中;它仅影响文档生成,不改变运行时或编译期行为,常与 @Retention(RetentionPolicy.RUNTIME) 配合使用。

documented注解在生成javadoc文档中的标记作用

@Documented 是 Java 中的一个元注解,它本身不改变程序逻辑,但会影响 Javadoc 文档的生成行为——具体来说,它决定**自定义注解是否会被包含在由 javadoc 工具生成的 HTML 文档中**。

让注解出现在 Javadoc 的类/方法说明里

默认情况下,JDK 不会把自定义注解(如 @Deprecated 以外的)显示在生成的 Javadoc 页面中。加上 @Documented 后,该注解就会作为“文档信息”被提取并展示在对应元素(类、方法、字段等)的 API 描述区域。

  • 例如:定义一个 @ApiVersion("2.0") 注解,并用 @Documented 标记它,那么在 Javadoc 中调用该方法的页面上,就会看到一行类似 @ApiVersion("2.0") 的标注。
  • 若未加 @Documented,即使代码里写了这个注解,Javadoc 输出中也不会出现它的痕迹。

只影响 Javadoc,不影响运行时或编译期

@Documented 属于 java.lang.annotation.RetentionPolicy.SOURCE 级别的元注解,但它不参与编译检查或反射读取控制。它的作用范围非常明确:

  • 不影响 @Retention 或 @Target 的语义
  • 不改变注解能否通过 getAnnotations() 获取(这由 @Retention(RetentionPolicy.RUNTIME) 决定)
  • 唯一效果:告诉 javadoc 工具“把这个注解当成文档内容来渲染”

典型使用场景

适用于需要向 API 使用者显式传达设计意图的注解,比如:

立即学习“Java免费学习笔记(深入)”;

  • 版本控制类注解:@ApiVersion、@Since
  • 权限或安全约束:@RequiresPermission、@RestrictedApi
  • 序列化相关:@JsonIgnore(如果自己实现类似功能)
  • 框架特有语义:@RestController(Spring)若希望在内部 Javadoc 中体现其角色,也可加 @Documented

和 @Retention 配合使用更常见

实际开发中,@Documented 往往与 @Retention(RetentionPolicy.RUNTIME) 一起出现,因为既要能在运行时通过反射获取,又希望在文档中可见:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface ApiVersion {
    String value();
}

这样既支持框架动态处理,也方便开发者查阅文档时快速识别接口契约。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2211

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

417

2026.01.26

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

3048

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

4349

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3689

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

386

2026.01.19

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

160

2026.09.23

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

80

2026.09.23

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

80

2026.09.23

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn