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 块

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

Decktopus AI
Decktopus AI

AI在线生成高质量演示文稿

下载

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

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

合格的文档注释应包含:

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

示例:

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

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

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

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

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
string转int
string转int

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

910

2023.08.02

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

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

252

2023.09.22

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

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

988

2024.03.01

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

839

2023.08.22

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

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

678

2023.08.03

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

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

219

2023.09.04

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

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

1561

2023.10.24

字符串介绍
字符串介绍

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

645

2023.11.24

Swift iOS架构设计与MVVM模式实战
Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践,系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例,帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

3

2026.03.03

热门下载

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

精品课程

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

共23课时 | 4.1万人学习

C# 教程
C# 教程

共94课时 | 10.6万人学习

Java 教程
Java 教程

共578课时 | 76.3万人学习

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

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