注释

< cpp

注释的作用是一套代码内文档。插入注释到程序中时，编译器实际上会忽略它们；它们的目的仅仅是被阅读源代码的人用作一种笔记。虽然专门的文档并不是 C++ 标准的一部分，但存在一些工具可以用于分析具有不同的文档格式的注释。

语法

	(1)
// 注释	(2)

1) 通称为“ C 风格”或“多行”注释。

2) 通称为“ C++ 风格”或“单行”注释。

在翻译阶段 3中，通过把每段注释替换为单个空白字符，所有的注释都被从程序中移除。

C 风格

C 风格注释通常用于注释大块的文本；不过也可以用它们注释单行文本。要插入一个 C 风格注释，可以简单地以 环绕文本；这样将使得注释的内容被编译器忽略掉。尽管不是 C++ 标准的一部分， 常用于指示文档块；这是合法的，因为第二个星号单纯地被地当做注释的一部分。

C++ 风格

C++ 风格注释通常用于注释单行文本或代码；不过也可以把多个 C++ 风格注释放在一起来组成多行注释。 C++ 风格注释告诉编译器忽略 // 和换行符间的所有内容。

注意

因为注释在预处理器阶段前已经被移除，所以宏不能用于组成注释，而且未终止的 C 风格注释不会从被 #include 的文件中漏出。

除了把代码注释掉之外，用于排除源代码的其他机制还有：

#if 0
    std::cout << "这一句不会被执行（甚至不会被编译）n";
#endif

以及

if(false) {
    std::cout << "这一句不会被执行n";
}

示例

 
// C++ 风格注释能注释一行
 
// 或者，能将
// 它们串在一起
 

int main()
{
  // 将不运行下方代码
  // return 1;
 
  // 将运行下方代码
  return 0;
}

参阅