单行注释与多行注释写法详解

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

单行注释用 // 开头，多行注释用 /* ... */ 包裹，这是大多数编程语言（如 JavaScript、Java、C/C++、TypeScript 等）的通用规范。

单行注释：简洁说明当前行或上一行代码

适合简短说明、临时禁用某行代码、标注小功能点。

• 写在代码上方或同行末尾，但保持可读性；同行末尾时，// 前至少留一个空格
• 避免写过长句子，超过 80 字建议拆成多行或改用多行注释
• 不要嵌套单行注释（虽然语法允许，但易出错且不清晰）

多行注释：解释复杂逻辑、函数用途或大段临时屏蔽

适用于函数说明、算法描述、版权信息、临时注释掉多行代码等场景。

• 开头用 /*，结尾用 */，中间每行无需额外符号，但常用 * 对齐提升可读性
• 禁止嵌套多行注释（/* /* ... */ */ 会报错），需改用多个单行注释替代
• 文档类注释（如 JSDoc）虽也用 /** ... */，但它属于扩展语法，不是基础多行注释

注意不同语言的细微差异

多数主流语言一致，但仍有例外：

• Python 使用 # 表示单行注释，无原生多行注释语法（用三引号字符串模拟，但非真注释）
• HTML 使用 ，不支持 // 或 /* */
• SQL 中 -- 是单行注释，/* ... */ 是多行注释（部分方言如 MySQL 支持）

良好习惯：注释要“说人话”，更要随代码更新

注释不是装饰，而是协作和维护的关键线索。

• 写注释前先想清楚：是解释“做什么”，还是“为什么这么做”？后者更有价值
• 代码重构后，务必同步检查并更新相关注释，过时注释比没注释更危险
• 避免无意义注释，例如 // i++ 或 // 返回 true

好了，本文到此结束，带大家了解了《单行注释与多行注释写法详解》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！