代码注释¶

代码注释几乎是每个编程语言都必有的功能，它的主要作用就是让开发者能够更好、更快速的阅读代码理解其的意思。在 C++ 中有着多种的注释方式，每种注释方式都有其对应的使用场景。

在 C++ 中最基本且最常用的注释方式有以下两种:

单行注释¶

单行注释以两个双斜杠 // 开始直至本行结束，编译器会在编译的过程中自动忽略双斜杠后面的全部内容。

单行注释通常用来描述解释变量的用处，其通常写在需要解释的代码上方一行。具体使用方式如下:

// 小明的年龄为18岁
int age = 18;

由于单行注释的特性，也可以将其写在某行代码的后方，具体使用场景为定义了多个变量需要描述解释。

小技巧

为了让代码看起来更加的整洁美观，我们通常会使用 Tab 键来让代码或注释缩进使其与上下行的代码垂直对齐。

int age{18};        // 定义年龄
int score{512};     // 定义成绩

多行注释以单斜杠加星号开头 /* 以星号加单斜杠结尾 */ 编译器会忽略这两个多行注释符号内的所有内容，常用于需要大量说明的代码。例如用来描述某个函数的功能和所需的参数。

/*
    整型函数
    进行 A + B 操作
    将返回计算结果
*/

int Addition(int A, int B) {
    int C = A + B;
    return C;
}

注意

C++ 中的多行注释不能嵌套使用，即不能在一个 /* */ 注释内部再使用另一个 /* */ 注释。

如果在开发过程中你需要临时屏蔽某些代码但又不想删除的时候，也可以使用注释来进行屏蔽。

// int C = A + B;

编写代码注释时候通常需要遵守以下几个默认行为规范。

实时更新: 当你对代码进行了改动，请确保注释也进行对应的更新，防止出现注释与代码的实际功能有差异。过时的注释比没有注释更糟糕。

表明实意: 注释应该表达代码无法直接传递的实际意思，而不是重复的表达代码的内容。

注释方案: 在大型项目中尽量使用 Doxygen 注释语法，这样做的好处就是能够提升注释的可读性也可编译成项目文档。

适度注释: 不要为每一行代码都添加注释，这会增加维护负担。只在必要的地方添加注释，解释 "为什么" 而不是 "是什么"。