Java注释写法:单行多行规范详解
2026-04-25 09:47:32
0浏览
收藏
Java注释看似简单,实则是提升代码可读性、协作效率与长期可维护性的关键实践——本文系统详解三种注释(单行//、多行/*...*/、文档/**...*/)的正确用法、典型场景与常见陷阱:从如何简洁标注逻辑、安全屏蔽代码,到规范编写可生成Javadoc的API文档;更强调注释不是装饰,而是责任——需同步更新、拒绝冗余、不掩盖问题,并倡导团队统一风格。掌握这些细节,让你的代码不仅机器能懂,更让同事一眼心领神会。

Java注释用 // 写单行,用 /* ... */ 写多行,文档注释用 /** ... */ 生成API说明。
单行注释:用两个斜杠(//)
从 // 开始到行末的所有内容都会被编译器忽略。适合简短说明、临时禁用某行代码或标注小逻辑。
- 写在代码上方或同行末尾均可,但建议保持对齐、不挤占可读性
- 避免过度使用,比如每行都加无意义的注释(如 // i++)
- 示例:
// 计算用户积分,按登录天数累加
int score = days * 10;
int bonus = (isVip ? 50 : 0); // VIP用户额外奖励
多行注释:用 /* ... */ 包裹
适用于跨多行的说明、暂时屏蔽一段代码,或写较详细的内部说明。
- 不能嵌套,即 /* ... /* ... */ ... */ 是非法的
- 注意缩进和换行,避免把关键代码意外包进注释里
- 示例:
/*
初始化配置参数:
- timeout:连接超时毫秒数
- retries:失败重试次数
*/
config.setTimeout(5000);
文档注释:用 /** ... */ 生成Javadoc
这是专为生成API文档设计的注释,必须放在类、方法、字段等声明之前,支持特定标签(如 @param、@return、@throws)。
- 每个 public 类/方法/字段建议配文档注释,尤其对外提供接口时
- 常用标签:
@param name 描述参数含义
@return 描述返回值
@throws ExceptionName 说明可能抛出的异常 - 示例:
/**
* 根据用户ID查询完整信息
* @param userId 用户唯一标识,不能为空
* @return User对象,查不到返回null
* @throws IllegalArgumentException 当userId为null或空字符串时抛出
*/
public User findUserById(String userId) { ... }
实用建议与避坑点
- 注释要随代码更新,过时注释比没注释更误导人
- 别用注释代替清晰命名(例如不用写 // i是循环变量,而应写 for (int index : list))
- 禁止用注释“掩盖”坏代码(如大段被注释掉的旧逻辑),该重构就重构
- 团队中可约定注释风格(如是否在 // 后加空格、多行注释是否用星号对齐),提升一致性
以上就是《Java注释写法:单行多行规范详解》的详细内容,更多关于的资料请关注golang学习网公众号!
Flask-Login多角色权限实现教程
- 上一篇
- Flask-Login多角色权限实现教程
- 下一篇
- Python中int代表什么?整数类型全解析
查看更多
最新文章
-
- 文章 · java教程 | 23分钟前 | Java · 日期时间 · java locale LocalDate WeekFields weekOfMonth DayOfWeek
- Java WeekFields.weekOfMonth 怎样按地区规则计算月份中的周数
- 274浏览 收藏
-
- 文章 · java教程 | 1小时前 | Java · java MethodType lastParameterType
- Java MethodType.lastParameterType 怎样读取方法类型的最后一个参数
- 267浏览 收藏
-
- 文章 · java教程 | 1小时前 | 反射 · 迁移 · Java教程 · java 方法句柄 MethodHandle MethodType MethodHandles.empty
- Java MethodHandles.empty 怎样构造接受参数但不执行操作的方法句柄
- 387浏览 收藏
-
- 文章 · java教程 | 2小时前 |
- Java MethodHandles.arrayConstructor 怎样构造指定类型的数组创建句柄
- 296浏览 收藏
-
- 文章 · java教程 | 3小时前 | Java · 字符集 · java 字符集编码 CharsetEncoder isLegalReplacement 替代字节
- Java CharsetEncoder.isLegalReplacement 怎样检查替代字节序列能否被编码器接受
- 365浏览 收藏
-
- 文章 · java教程 | 4小时前 | Java · nio · java FileStore getBlockSize 文件系统块大小
- Java FileStore.getBlockSize 怎样查询文件系统块大小
- 428浏览 收藏
-
- 文章 · java教程 | 4小时前 | Java教程 · 日期时间 · java LocalDate WeekFields weekBasedYear weekOfWeekBasedYear ISO周
- Java WeekFields.weekBasedYear 怎样读取周所属年份而不是日历年份
- 401浏览 收藏
-
- 文章 · java教程 | 5小时前 | Java教程 · java optional JPMS Mainclass ModuleDescriptor module-info.class
- Java ModuleDescriptor.mainClass 怎样读取模块声明的主类名称
- 109浏览 收藏
-
- 文章 · java教程 | 6小时前 | Java · java ThreadMXBean ThreadInfo isInNative
- Java ThreadInfo.isInNative 怎样判断线程是否在执行本地方法
- 132浏览 收藏
-
- 文章 · java教程 | 7小时前 | 标准库 · Java教程 · java 反射 MethodHandle MethodType parameterArray
- Java MethodType.parameterArray 怎样复制方法类型的参数类型数组
- 397浏览 收藏
-
- 文章 · java教程 | 7小时前 | 标准库 · Java教程 · java 默认值 ZeRO MethodHandles MethodHandle
- Java MethodHandles.zero 怎样生成返回指定类型零值的方法句柄
- 206浏览 收藏
-
- 文章 · java教程 | 9小时前 | Java · 数组 · java 数组长度 MethodHandles MethodHandle arrayLength
- Java MethodHandles.arrayLength 怎样构造读取数组长度的方法句柄
- 432浏览 收藏
查看更多
课程推荐
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
查看更多
AI推荐
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1096次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1092次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1260次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1201次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1049次使用
查看更多
相关文章
-
- Java 时间格式兼容多个输入格式的方法
- 2026-10-18 501浏览
-
- Java try-with-resources 多个资源关闭顺序是什么
- 2026-09-10 501浏览
-
- 矩阵主副对角线快速定位技巧
- 2026-05-31 501浏览
-
- Java多态优化流程代码与行为分发改进
- 2026-05-26 501浏览
-
- JVM 类元数据双亲委派链表深度解析
- 2026-05-21 501浏览

