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

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

千丽姑娘_1960

千丽姑娘_1960

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

|

300人浏览过

|

来源于php中文网

原创

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

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

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

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

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

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

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

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

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

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

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

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

Java Api Extractor
Java Api Extractor

从 Java 项目中提取 Controller 层接口定义为 JSON 数据。

下载

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

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

合格的文档注释应包含:

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

示例:

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

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

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

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

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

热门AI工具

更多
火山引擎

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

豆包大模型

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

WorkBuddy

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

DeepSeek

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

音述AI
音述AI Hot

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

6899

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

549

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1698

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1838

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2904

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6224

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

6089

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

7674

2024.03.22

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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