注释

来自cppreference.com
< cpp

注释是一种在代码之中的文档。插入到程序中的注释实际上会被编译器忽略;它们仅仅是为阅读代码的人准备的注解。虽然专门的文档并不是 C++ 标准的一部分,但是存在一些工具可以把注释以不同的文档格式解析出来。

目录

[编辑] 语法

/* comment */ (1)
// comment\n (2)
1) 通常被称为“C 风格”或“多行”注释。
2) 通常被称为“C++ 风格”或“单行”注释。

翻译阶段 3 中,所有的注释都从程序中移除掉了,每个注释都被替换为一个空白字符。

[编辑] C 风格

C 风格的注释通常用来注释大块文本,不过它们也可以用来注释单行文本。要插入一个 C 风格的注释,简单地用 /**/ 环绕文字,这会使注释的内容被编译器忽略。虽然这不属于 C++ 标准,但是 /***/ 通常被用来表示文档块,这是合法的,因为其第二个星号将仅被视为注释的一部分。C 风格的注释不能嵌套。

[编辑] C++ 风格

C++ 风格的注释通常用于单行注释,不过也可以将多个 C​​++ 风格的注释放在一起来组成多行注释。C++ 风格的注释告诉编译器忽略 // 和新行之间的所有内容。

[编辑] 注解

由于注释在预处理器的阶段之前就被删除了,所以无法用宏来构成注释,而且未结束的 C 风格的注释也不会从被 #include 的文件中跨越出去。

除了注释之外,还有其他的机制可以用来把源代码排除掉:

#if 0
    std::cout << "this will not be executed or even compiled\n";
#endif

以及

if(false) {
    std::cout << "this will not be executed\n"
}

[编辑] 示例

/* C 风格的注释可以
包含多行文本 */
/* 或者只有一行 */
 
// C++ 风格的注释可以注释一行
 
// 或者把它们
// 连在一起
 
int main()
{
  // 下面的代码不会运行
  // return 1;
 
  // 下面的代码会运行
  return 0;
}