注释

来自cppreference.com
< cpp

注释的作用是一套代码内文档。插入注释到程序中时,编译器直接忽略它们;它们只是有意地被人类用作读取源码的笔记。虽然特定的文档不是 C++ 标准的一部分,但是存在一些分析带不同格式文档的工具。

目录

[编辑] 语法

/* 注释 */ (1)
// 注释\n (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 风格注释
能含有多行。
*/
 
/* 或仅一行。 */
 
// C++ 风格注释能注释一行。
 
// 或者,能将
// 它们串在一起。
 
int main()
{
  // 将不运行下方代码
  // return 1;
 
  // 将运行下方代码
  return 0;
}


[编辑] 参阅

注释C 文档