单行注释//用于简短说明,推荐置于代码上方;块注释/.../用于多行描述或函数说明,不可嵌套。

在C++中,// 和 /* ... */ 都是合法的注释方式,但它们适用的场景和规范使用方式有所不同。合理使用能提升代码可读性和维护性。
单行注释 // 的使用规范
适用于对单行代码或简短语句的说明。
- 用于解释某一行或紧接着的代码的作用,比如变量用途、逻辑意图
- 通常放在被注释代码的上方或右侧,上方更推荐
- 避免过度注释显而易见的代码,如 // 增加i的值 这类冗余说明
- 连续多行注释建议每行都用 //,保持风格统一
示例:
// 计算圆的面积double radius = 5.0;
double area = M_PI * radius * radius; // 使用公式 πr²
块注释 /* ... */ 的使用规范
适合用于多行说明、函数说明、版权信息或临时禁用代码块。
立即学习“C++免费学习笔记(深入)”;
《PHP设计模式》首先介绍了设计模式,讲述了设计模式的使用及重要性,并且详细说明了应用设计模式的场合。接下来,本书通过代码示例介绍了许多设计模式。最后,本书通过全面深入的案例分析说明了如何使用设计模式来计划新的应用程序,如何采用PHP语言编写这些模式,以及如何使用书中介绍的设计模式修正和重构已有的代码块。作者采用专业的、便于使用的格式来介绍相关的概念,自学成才的编程人员与经过更多正规培训的编程人员
- 常用于函数或类的说明,描述功能、参数、返回值等(但更推荐用Doxygen风格)
- 可以跨行,适合大段文字说明
- 不能嵌套,/* /* 内层 */ 外层 */ 会导致编译错误
- 调试时可用于“注释掉”一段代码,但完成后应清理
示例:
/** 计算斐波那契数列第n项
* 参数: n 必须为非负整数
* 返回: 第n项的值,时间复杂度 O(2^n)
*/
int fib(int n) {
if (n return fib(n - 1) + fib(n - 2);
}
如何选择注释方式
根据实际场景选择更合适的注释形式,保持项目内统一。
- 日常代码说明优先使用 //,简洁清晰
- 需要跨行文档化时用 /* ... */,尤其是配合文档生成工具
- 团队开发应制定注释规范,比如Doxygen注释统一用 /** ... */
- 避免在代码中遗留被注释掉的“死亡代码”,应及时删除
基本上就这些。注释的核心是帮助理解,而不是堆砌文字。保持简洁、准确、及时更新,才是良好注释的关键。








