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

Java代码自动生成:利用@Documented标记辅助生成

酷浩吖_3238

酷浩吖_3238

发布时间:2026-07-01 10:58:34

|

527人浏览过

|

来源于php中文网

原创

@Documented仅用于Javadoc文档生成,不参与代码生成;它作为元注解不影响编译、运行、APT或Lombok等工具,真正驱动代码生成的是注解处理器、Lombok插件、模板引擎或IDE脚本。

java代码自动生成:利用@documented标记辅助生成

Java中@Documented本身不参与代码生成,它只是告诉Javadoc工具将该注解保留在生成的文档中。想靠它“自动生成代码”属于常见误解——它不触发编译期处理、不修改字节码、也不被IDE或构建工具直接用于生成源码。

为什么@Documented不能生成代码

@Documented是元注解(meta-annotation),作用域仅限于Javadoc。它的存在与否,对编译、运行、注解处理器(APT)或Lombok等代码生成工具完全无影响。比如:

  • 哪怕你给自定义注解加上@Documented,javac也不会因此多生成一行getter方法;
  • Spring Boot的@ConfigurationProperties能生成元数据文件,靠的是专门的@ConstructorBinding和APT,不是@Documented;
  • Lombok的@Data背后是JSR 269注解处理器,@Documented在其中只是让Lombok自己的注解出现在API文档里。

真正能驱动代码生成的机制

如果目标是“自动生成Java代码”,应聚焦以下实际可用的技术路径:

  • 注解处理器(Annotation Processing Tool, APT):在编译期扫描特定注解,生成.java文件(如Room、MapStruct、AutoValue);
  • Lombok:通过JVM Agent或编译器插件,在编译阶段重写AST,生成构造器、getter/setter等;
  • 模板引擎+配置文件:用FreeMarker/Velocity读取JSON/YAML模型,生成DAO、DTO等批量代码;
  • IDE插件或脚本:IntelliJ Live Templates、VS Code Snippets,或用Python脚本解析类结构后生成配套代码。

@Documented的合理使用场景

它唯一价值是提升文档可读性。当你开发公共SDK或框架时,建议为自定义注解添加@Documented:

Java Maven Secondary Analysis
Java Maven Secondary Analysis

分析ZIP压缩包或GitLab仓库中的Java Maven项目,确定二次开发范围、类数量、模块分布及生产相关指标。

下载

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

  • 用户在IDE里按Ctrl+J(或Cmd+J)查看注解说明时,能看到你写的JavaDoc;
  • Javadoc站点中,该注解会连同其说明一起出现在“Annotations”章节;
  • 配合@Retention(RetentionPolicy.RUNTIME)和@Target,构成完整、易用的注解设计。

一个典型示例

假设你写了一个校验注解@NonEmpty:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented  // ← 这行让Javadoc包含它
public @interface NonEmpty {
    String message() default "must not be empty";
}

加上@Documented后,团队成员执行mvn javadoc:javadoc,就能在生成的HTML文档里直接看到@NonEmpty的用途和参数说明——这提升了协作效率,但没生成任何新Java类。

热门AI工具

更多
豆包大模型

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

DeepSeek

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

LibLibAI
LibLibAI Hot

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

WorkBuddy

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

立刻MV
立刻MV Hot

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

Seko
Seko Hot

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

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

9977

2023.06.15

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

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

7102

2023.07.05

java自学难吗
java自学难吗

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

6252

2023.07.31

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

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

1084

2023.08.01

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

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

908

2023.08.02

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

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

1316

2023.08.02

java有什么用
java有什么用

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

2629

2023.08.02

java在线网站
java在线网站

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

19951

2023.08.03

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

0

2026.10.08

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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