C++ 注释¶

注释（Comment）是用于解释代码含义的说明性文本，不会影响程序的执行。在 C++ 代码中合理地使用注释，可以显著提高源代码的可读性和可维护性 。几乎所有编程语言都支持注释机制。

C++ 支持 单行注释 和 多行注释 两种形式，注释中的内容会被编译器完全忽略。

单行注释¶

单行注释以 // 开始，一直到该行末尾结束，通常用于对单行代码进行说明。

示例：

#include <iostream>
using namespace std;

int main()
{
    // 这是一个单行注释
    cout << "Hello World!";
    return 0;
}

单行注释也可以写在语句的末尾：

#include <iostream>
using namespace std;

int main()
{
    cout << "Hello World!"; // 输出 Hello World!
    return 0;
}

在编译上述程序时，编译器会忽略所有以 // 开头的注释内容，程序最终输出结果为：

Hello World!

多行注释¶

多行注释以 /* 开始，以 */ 结束，通常用于对多行代码或一段逻辑进行说明。

示例：

#include <iostream>
using namespace std;

int main()
{
    /* 这是一个多行注释 */

    /* C++ 注释也可以
     * 跨越多行
     */
    cout << "Hello World!";
    return 0;
}

注释嵌套说明¶

在 /* ... */ 多行注释内部，// 不具有特殊含义；同样，在 // 单行注释中，/* 和 */ 也不会被当作注释起止符。

因此，可以在一种注释形式中 包含另一种注释符号 ，例如：

/* 用于输出 Hello World 的注释

cout << "Hello World!"; // 输出 Hello World

*/

⚠️ 注意： 同一种注释不能直接嵌套 （例如在 /* ... */ 中再次使用 /* ... */），否则会导致编译错误。

使用注释的建议¶

注释应说明 “为什么这样写” ，而不仅仅是 “做了什么” ；
保持注释简洁、准确，避免与代码含义不一致；
对复杂逻辑、关键算法或重要接口进行必要说明。