单行注释与多行注释写法详解
2026-04-15 16:21:24
0浏览
收藏
掌握正确的注释写法是提升代码可读性与团队协作效率的关键——本文系统梳理了单行注释(//)与多行注释(/* ... */)的通用规范、适用场景及常见陷阱,强调注释应聚焦解释“为什么”而非“做什么”,并深入对比Python、HTML、SQL等语言的语法差异,同时提醒读者警惕过时注释的危害、避免嵌套误区,并倡导随代码演进及时更新注释,让每一行注释真正成为维护代码生命力的可靠线索。

单行注释用 // 开头,多行注释用 /* ... */ 包裹,这是大多数编程语言(如 JavaScript、Java、C/C++、TypeScript 等)的通用规范。
单行注释:简洁说明当前行或上一行代码
适合简短说明、临时禁用某行代码、标注小功能点。
- 写在代码上方或同行末尾,但保持可读性;同行末尾时,// 前至少留一个空格
- 避免写过长句子,超过 80 字建议拆成多行或改用多行注释
- 不要嵌套单行注释(虽然语法允许,但易出错且不清晰)
// 计算用户登录失败次数
let failCount = getUserFailures(userId); // 仅对当前行补充说明
多行注释:解释复杂逻辑、函数用途或大段临时屏蔽
适用于函数说明、算法描述、版权信息、临时注释掉多行代码等场景。
- 开头用 /*,结尾用 */,中间每行无需额外符号,但常用 * 对齐提升可读性
- 禁止嵌套多行注释(/* /* ... */ */ 会报错),需改用多个单行注释替代
- 文档类注释(如 JSDoc)虽也用 /** ... */,但它属于扩展语法,不是基础多行注释
/*
* 验证邮箱格式是否合法
* 支持常见域名后缀,不校验 DNS 存在性
*/
function isValidEmail(str) { ... }
注意不同语言的细微差异
多数主流语言一致,但仍有例外:
- Python 使用 # 表示单行注释,无原生多行注释语法(用三引号字符串模拟,但非真注释)
- HTML 使用 ,不支持 // 或 /* */
- SQL 中 -- 是单行注释,/* ... */ 是多行注释(部分方言如 MySQL 支持)
良好习惯:注释要“说人话”,更要随代码更新
注释不是装饰,而是协作和维护的关键线索。
- 写注释前先想清楚:是解释“做什么”,还是“为什么这么做”?后者更有价值
- 代码重构后,务必同步检查并更新相关注释,过时注释比没注释更危险
- 避免无意义注释,例如 // i++ 或 // 返回 true
好了,本文到此结束,带大家了解了《单行注释与多行注释写法详解》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多文章知识!
AI视频伦理问题有哪些?
- 上一篇
- AI视频伦理问题有哪些?
- 下一篇
- 多图横向浮动实现技巧分享
查看更多
最新文章
-
- 文章 · java教程 | 4小时前 | nio · Java教程 · 文件系统 · java FileStore supportsFileAttributeView 文件属性视图
- Java FileStore.supportsFileAttributeView 怎样判断存储卷支持哪些文件属性视图
- 176浏览 收藏
-
- 文章 · java教程 | 5小时前 | Java · 日期时间 · java locale LocalDate WeekFields weekOfMonth DayOfWeek
- Java WeekFields.weekOfMonth 怎样按地区规则计算月份中的周数
- 274浏览 收藏
-
- 文章 · java教程 | 5小时前 | Java · java MethodType lastParameterType
- Java MethodType.lastParameterType 怎样读取方法类型的最后一个参数
- 267浏览 收藏
-
- 文章 · java教程 | 6小时前 | 反射 · 迁移 · Java教程 · java 方法句柄 MethodHandle MethodType MethodHandles.empty
- Java MethodHandles.empty 怎样构造接受参数但不执行操作的方法句柄
- 387浏览 收藏
-
- 文章 · java教程 | 7小时前 |
- Java MethodHandles.arrayConstructor 怎样构造指定类型的数组创建句柄
- 296浏览 收藏
-
- 文章 · java教程 | 8小时前 | Java · 字符集 · java 字符集编码 CharsetEncoder isLegalReplacement 替代字节
- Java CharsetEncoder.isLegalReplacement 怎样检查替代字节序列能否被编码器接受
- 365浏览 收藏
-
- 文章 · java教程 | 8小时前 | Java · nio · java FileStore getBlockSize 文件系统块大小
- Java FileStore.getBlockSize 怎样查询文件系统块大小
- 428浏览 收藏
-
- 文章 · java教程 | 9小时前 | Java教程 · 日期时间 · java LocalDate WeekFields weekBasedYear weekOfWeekBasedYear ISO周
- Java WeekFields.weekBasedYear 怎样读取周所属年份而不是日历年份
- 401浏览 收藏
-
- 文章 · java教程 | 10小时前 | Java教程 · java optional JPMS Mainclass ModuleDescriptor module-info.class
- Java ModuleDescriptor.mainClass 怎样读取模块声明的主类名称
- 109浏览 收藏
-
- 文章 · java教程 | 11小时前 | Java · java ThreadMXBean ThreadInfo isInNative
- Java ThreadInfo.isInNative 怎样判断线程是否在执行本地方法
- 132浏览 收藏
-
- 文章 · java教程 | 11小时前 | 标准库 · Java教程 · java 反射 MethodHandle MethodType parameterArray
- Java MethodType.parameterArray 怎样复制方法类型的参数类型数组
- 397浏览 收藏
-
- 文章 · java教程 | 12小时前 | 标准库 · Java教程 · java 默认值 ZeRO MethodHandles MethodHandle
- Java MethodHandles.zero 怎样生成返回指定类型零值的方法句柄
- 206浏览 收藏
查看更多
课程推荐
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
查看更多
AI推荐
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1100次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1095次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1266次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1205次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1051次使用
查看更多
相关文章
-
- 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浏览

