Java注释能否保留在编译后的字节码中?
时间:2026-04-11 19:49:33 469浏览 收藏
Java中的普通注释(如//和/* */)在编译时即被javac彻底丢弃,不会以任何形式进入字节码;真正能保留到class文件的是基于@Retention策略的注解(如@Deprecated),而Javadoc注释(/** */)仅用于生成API文档,与运行时无关——若你误以为注释内容能自动出现在字节码或运行时环境中,这篇文章将帮你彻底厘清这三大类“注释”的本质区别,并指出唯一可靠地让说明文字进入字节码的方法:显式定义字符串常量。

Java注释会被编译进class文件吗
不会。普通单行//和块注释/* */在编译阶段就被javac完全丢弃,字节码里找不到任何痕迹。
只有@Deprecated这类标记型注解(不是注释)会保留到字节码——但这是注解(@interface定义的),和人写的说明性注释是两回事。
@Documented注解和javadoc的关系
@Documented只影响javadoc工具能否把该注解本身生成进API文档,和源码里的/** */注释是否被提取无关。
javadoc能提取的是符合Javadoc语法的/** */注释(含@param、@return等标签),它不读取@Documented,也不依赖运行时注解保留策略。
常见错误现象:
– 写了@Documented但没写/** */,结果javadoc里啥也没有
– 在//里写了详细说明,以为javadoc能扫到,实际完全忽略
Runtime注解保留策略对字节码的影响
注解是否进入字节码,取决于它的@Retention策略:
@Retention(RetentionPolicy.SOURCE):仅保留在源码,编译后消失(如@Override)@Retention(RetentionPolicy.CLASS):保留在class文件,但JVM加载时不进内存(默认值)@Retention(RetentionPolicy.RUNTIME):进class文件,且可被反射读取
注意:RetentionPolicy.CLASS和RUNTIME都会让注解数据写入字节码的RuntimeVisibleAnnotations属性,只是后者多了JVM支持反射访问。
性能影响很小,但RUNTIME注解会增加class体积,并可能被反射意外调用——不用反射就别设成RUNTIME。
想让说明文字进字节码?只能靠常量或字符串
如果真需要“注释内容”出现在运行时(比如调试信息、配置描述),唯一可靠方式是显式转成字符串常量:
public static final String SERVICE_DESC = "处理订单超时重试,幂等由上游保证";
或者用private static final字段+构造器初始化。不要指望任何注释语法能绕过javac的剥离逻辑。
容易被忽略的一点:IDE和构建工具(如Gradle的javadocJar)可能缓存旧的javadoc输出,改了/** */注释后没重新运行javadoc任务,就会看到“注释没更新”的假象。
文中关于的知识介绍,希望对你的学习有所帮助!若是受益匪浅,那就动动鼠标收藏这篇《Java注释能否保留在编译后的字节码中?》文章吧,也可关注golang学习网公众号了解相关技术文章。
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
265 收藏
-
154 收藏
-
419 收藏
-
171 收藏
-
450 收藏
-
354 收藏
-
179 收藏
-
262 收藏
-
351 收藏
-
436 收藏
-
123 收藏
-
265 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习