命名空间
变体
操作

注释

来自 cppreference.cn
< cpp
 
 
C++ 语言
 
 

注释作为一种代码内文档。当插入到程序中时,它们实际上被编译器忽略;它们仅供阅读源代码的人类用作笔记。尽管具体的文档不属于 C++ 标准的一部分,但存在一些实用程序可以解析不同文档格式的注释。

目录

[编辑] 语法

/* 注释 */ (1)
// 注释 (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";
}

[编辑] 示例

#include <iostream>
 
/* C-style comments can contain
multiple lines */
/* or just one */
 
/**************
 *  you can insert any *, but
 *  you can't make comments nested
 */
 
// C++-style comments can comment one line
 
// or, they can
// be strung together
 
int main()
{
    // comments are removed before preprocessing,
    // so ABC is "1", not "1//2134", and "1 hello world"
    // will be printed
#define ABC 1//2134
    std::cout << ABC << " hello world\n";
 
    // The below code won't be run
    // return 1;
 
    // The below code will be run
    return 0;
}

输出

1 hello world

[编辑] 另请参阅

C 文档 关于 注释