C++ 注释 - C++

什么是注释？

在编写代码时，为了方便其他开发者或自己日后的阅读、维护和修改，往往需要对特定代码部分加以说明和解释，这就是注释。

在 C++ 中，注释是一种文本形式的标记，编译器会将其忽略，因此不会对程序运行产生影响。注释可以是单行注释（//）或多行注释（/* */）。

单行注释

单行注释以两个斜杠（//）开头，可以跟在代码后面或单独一行，并且只注释这一行内容。例如：

int a = 20; // 定义一个整数变量 a，赋值为 20

多行注释

多行注释以 /* 开始，以 */ 结束，可注释多行内容，例如：

/*
这是一个多行注释示例，
用于演示如何使用多行注释。
*/

int b = 30; // 定义一个整数变量 b，赋值为 30

/*
注释也可以用来屏蔽一部分代码，
例如下面的语句不会被执行：
int c = 40;
*/

// 也可以在代码后面使用多行注释，如下所示：
float d = 4.5; /* 定义一个浮点数变量 d，赋值为 4.5 */

注释的作用

1. 解释代码的含义和用途，方便其他开发者或自己日后阅读、维护和修改代码。
2. 屏蔽一部分代码，从而达到调试或测试的作用。
3. 帮助编译器识别需要被忽略的代码，提高编译效率。

注释的注意事项

1. 注释的内容应该简洁明了，准确表达所注释代码的含义和作用。
2. 不应该出现无效注释，即对于容易理解的代码不应重复注释。
3. 应该尽量避免使用中文注释，因为不同编译器和操作系统对中文注释的支持有所不同。
4. 在进行代码修改时，应将相应的注释一同修改，确保注释和代码的一致性。