0

0

Java中的注释有哪些类型_代码注释规范解析

P粉602998670

P粉602998670

发布时间:2025-12-26 17:16:02

|

260人浏览过

|

来源于php中文网

原创

Java注释分三种:单行(//)、多行(/.../)、文档(/*.../);分别用于行级说明、块级禁用、API文档生成,核心是提升可读性与协作性,且需随代码同步更新。

java中的注释有哪些类型_代码注释规范解析

Java 中的注释共三种:单行注释、多行注释、文档注释。它们用途不同,语法不同,编译器处理方式也不同——但核心目标一致:让代码更易读、可维护、可协作。

单行注释(//)适合快速说明和临时禁用

// 开头,作用范围仅限当前行末尾。常用于:

  • 解释某一行变量或逻辑的意图,比如 int timeout = 3000; // 单位毫秒,超时阈值
  • 临时屏蔽一行代码调试,如 // System.out.println("debug: " + value);
  • 标记待办事项,配合 TODOFIXME 等关键词,例如 // TODO: 后续支持异步回调

注意:不要堆叠多行 // 来模拟多行注释;也不要用它重复代码已明确表达的动作(如 i++; // i加1)。

多行注释(/* ... */)用于块级说明或临时停用代码段

/* 开始、*/ 结束,中间内容完全被忽略。适用于:

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

  • 对几行相关代码做整体说明,比如算法步骤、业务规则限制
  • 临时注释掉一段暂时不用但可能恢复的代码(比删掉更安全)
  • 在调试中批量禁用逻辑分支,例如整个 if 块

关键限制:不能嵌套使用,即 /* 外层 /* 内层 */ 外层 */ 是非法的;但内部可以包含 //,不影响语法解析。

文档注释(/** ... */)是生成 API 文档的唯一标准形式

/** 开始、*/ 结束,必须紧贴在类、接口、方法、字段等成员声明之前。它的价值在于可被 javadoc 工具提取并生成 HTML 文档。

AITDK
AITDK

免费AI SEO工具,SEO的AI生成器

下载

合格的文档注释应包含:

  • 首句用动词开头,概括功能(如 “验证用户邮箱格式是否合法”)
  • 使用标准标签说明关键信息:@param 描述参数含义与约束,@return 说明返回值语义,@throws 列出可能异常及触发条件
  • 避免空泛描述,聚焦“为什么这么设计”或“调用者需注意什么”

示例:

// 正确写法
/**
  * 根据手机号查询用户基本信息,不包含敏感字段。
  * @param phone 手机号,11位数字字符串,不能为空
  * @return 用户对象;若未找到或格式非法,返回 null
  * @throws IllegalArgumentException 当 phone 含非数字字符时抛出
  */
public User findUserByPhone(String phone) { ... }

注释不是装饰,而是沟通契约

真正有用的注释回答的是“为什么”,而不是“做什么”。代码本身应尽量自解释(靠命名、结构、拆分),注释则补足那些无法从语法直接看出的信息:

  • 隐藏的约束(如“此方法线程不安全,调用方需自行同步”)
  • 权衡取舍(如“此处用 HashMap 而非 TreeMap,因无需排序且读多写少”)
  • 外部依赖(如“该时间戳来自 NTP 服务器,误差控制在 ±50ms 内”)

一旦代码修改,对应注释必须同步更新;过期注释比没有更危险。

相关专题

更多
java
java

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

651

2023.06.15

java流程控制语句有哪些
java流程控制语句有哪些

java流程控制语句:1、if语句;2、if-else语句;3、switch语句;4、while循环;5、do-while循环;6、for循环;7、foreach循环;8、break语句;9、continue语句;10、return语句。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

455

2024.02.23

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

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

722

2023.07.05

java自学难吗
java自学难吗

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

725

2023.07.31

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

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

394

2023.08.01

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

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

398

2023.08.02

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

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

441

2023.08.02

java有什么用
java有什么用

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

427

2023.08.02

虚拟号码教程汇总
虚拟号码教程汇总

本专题整合了虚拟号码接收验证码相关教程,阅读下面的文章了解更多详细操作。

25

2025.12.25

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2万人学习

C# 教程
C# 教程

共94课时 | 5.3万人学习

Java 教程
Java 教程

共578课时 | 37.9万人学习

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

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号