代码注释¶
代码注释几乎是每个编程语言都必有的功能，它的主要作用就是让开发者能够更好更快速的阅读代码理解其的意思。在 C++ 中有着多种的注释类型，每个注释类型都有其对应的使用方式和适合的使用场景。
基础注释¶
在 C++ 中最基本且最常用的注释类型有以下两种:
单行注释
多行注释
单行注释¶
单行注释以两个双斜杠 // 开始直至本行结束，编译器会在编译的过程中自动忽略双斜杠后面的全部内容。
单行注释通常用来描述解释变量的用处，其通常写在需要解释的代码上方一行。具体使用方式如下:
// 小明的年龄为18岁
int age = 18;
由于单行注释的特性也可以将其写在某行代码的后方，具体使用场景为定义了多个变量需要描述解释。
备注
为了让代码看起来更加的整洁美观，我们通常会使用 Tab 键来让代码或注释缩进使其与上下行的代码垂直对齐。
char C = "A"; // 字母 A
int ID = "5201314" // 身份标识
多行注释¶
多行注释以单斜杠加星号开头 /* 以星号加单斜杠结尾 */ 编译器会忽略这两个多行注释符号内的所有内容，常用于需要大量说明的代码。例如用来描述某个函数的功能和所需的参数。
/*
下方函数是用来进行加法计算的
调用此函数进行 A + B 操作
将返回计算结果
*/
int Addition(int A, int B) {
int C = A + B;
return C;
}
如果想要美化多行注释代码可以添加一些 ASCII 符号进行美化。
/*
==== 函数说明 ====
这里是函数的使用说明
==== 参数说明 ====
这里是参数的传参说明
*/
如果在开发过程中你需要临时屏蔽某些代码但又不想删除的时候也可以使用注释来进行屏蔽。
// int C = A + B;
高级注释¶
在普通注释的基础上高级注释可以使用特殊工具如 Doxygen 提取 C++ 的代码和对应的 Doxygen 注释编译成一个在线文档或 PDF 能够让开发者在无需翻阅大量代码的前提下精准的找到自己想要查看的代码的对应描述，同时高级注释语法支持将整个代码文件进行注释描述。
代码文件注释¶
/**
* @file 当前代码文件名
* @brief 此代码文件的说明
* @details 一些细节
* @mainpage 工程概览
* @author 作者
* @email 邮箱
* @version 版本号
* @date 年-月-日
* @license 版权
*/
更多高级注释语法可以前往 Doxygen 官网 https://www.doxygen.nl/manual/index.html 查看官方文档
提醒注释¶
该类型注释通常由开发工具定义与实现具体功能，其中 TODO 已经被绝大多数的开发工具所兼容，它的功能是显示一个待办事项常用于用来标记接下来所要进行的任务或所需修改的功能。
TODO¶
// TODO 接下来编写一个加法计算函数
// TODO 老板让我优化 *** 代码的运行速度
对于提醒类型的注释通常你的开发工具会在控制台中显示且高亮该注释所在行，有些开发工具会在你编译的时候终止并显示此行直至你删除了这个待办事项注释。
其它提醒注释¶
注释类型 |
作用和使用场景 |
示例 |
|---|---|---|
|
待办事项：最常用的一种，用于标记任何需要完成的任务，比如一个尚未实现的功能或需要补充的逻辑。 |
|
|
待修复：明确指出代码中存在一个已知但尚未修复的 bug。它的紧急程度通常比 |
|
|
临时方案：标记一段走了捷径或使用了不优雅方式实现的代码。这表示它能正常工作，但不是最佳实践，未来应该用更好的方法重构。 |
|
|
未完成：表示某段代码或一个功能块的开发被中断，尚未彻底完成。 |
|
|
警示/危险：用于标记代码中存在严重问题或可能导致风险的地方，需要特别注意。 |
|
|
笔记/说明：用于对某段复杂的代码进行解释或提供额外信息，帮助他人理解。 |
|
备注
并不是所有的开发工具都支持提醒注释，具体是否能用还要在你的开发工具上进行对应的测试。
注释规则¶
编写代码注释时候通常需要遵守以下几个默认行为规范。
实时注释: 当你对代码进行了改动请确保注释也进行对应的更新，防止出现注释与代码的实际功能有差异。
表明实意: 注释应该表达代码无法直接传递的实际意思，而不是重复的表达代码的内容。