注释
来自 cppreference.com
< c
注释是代码文档的一种形式。当插入到程序中时，它们实际上会被编译器忽略；它们仅用于作为阅读源代码的人类的注释。
内容 |
[编辑] 语法
/* 注释 */ |
(1) | ||||||||
// 注释 |
(2) | (自 C99 起) | |||||||
1) 通常被称为“C 样式”或“多行”注释。
2) 通常被称为“C++ 样式”或“单行”注释。
所有注释在翻译阶段 3中被移除，方法是用单个空格字符替换每个注释。
[编辑] C 样式
C 样式注释通常用于注释大块文本或代码的小片段；但是，它们可以用于注释单行。要插入文本作为 C 样式注释，只需将文本用/* 和 */ 括起来。C 样式注释告诉编译器忽略/* 和 */ 之间的所有内容。虽然这不是 C 标准的一部分，但/** 和 **/ 通常用于指示文档块；这是合法的，因为第二个星号只是被视为注释的一部分。
除了在字符常量、字符串字面量或注释中，字符/* 引入注释。此类注释的内容仅用于识别多字节字符并查找终止注释的字符*/。C 样式注释不能嵌套。
C++ 样式C++ 样式注释通常用于注释单行文本或代码；但是，它们可以放在一起形成多行注释。要插入文本作为 C++ 样式注释，只需在文本前加上 除了在字符常量、字符串字面量或注释中，字符 // y = f(x); // invoke algorithmC 样式注释可以出现在 C++ 样式注释中 // y = f(x); /* invoke algorithm */C++ 样式注释可以出现在 C 样式注释中；这是一种排除一小段源代码的方法 /*
y = f(x); // invoke algorithms
z = g(x);
*/ |
(自 C99 起) |
[编辑] 注释
因为注释在预处理阶段之前被移除，所以宏不能用于形成注释，未终止的 C 样式注释不会从 #include 的文件中溢出。
/* An attempt to use a macro to form a comment. */ /* But, a space replaces characters "//". */ #ifndef DEBUG #define PRINTF // #else #define PRINTF printf #endif ... PRINTF("Error in file %s at line %i\n", __FILE__, __LINE__);
除了注释掉，其他用于源代码排除的机制是
#if 0 puts("this will not be compiled"); /* no conflict with C-style comments */ // no conflict with C++-style comments #endif
和
if(0) { puts("this will be compiled but not be executed"); /* no conflict with C-style comments */ // no conflict with C++-style comments }
在 C99 中引入 // 注释是在某些罕见情况下的一次重大改变
a = b //*divisor:*/ c + d; /* C89 compiles a = b / c + d; C99 compiles a = b + d; */
[编辑] 示例
运行此代码
#include <stdio.h> /* C-style comments can contain multiple lines. */ /* Or, just one line. */ // C++-style comments can comment one line. // Or, they can // be strung together. int main(void) { // The below code won't be run // puts("Hello"); // The below code will be run puts("World"); // A note regarding backslash + newline. // Despite belonging to translation phase 2 (vs phase 3 for comments), // '\' still determines which portion of the source code is considered // as 'comments': // This comment will be promoted to the next line \ puts("Won't be run"); // may issue a warning "multi-line comment" puts("Hello, again"); }
输出
World Hello, again
[编辑] 参考文献
- C17 标准 (ISO/IEC 9899:2018)
- 6.4.9 注释 (p: 54)
- C11 标准 (ISO/IEC 9899:2011)
- 6.4.9 注释 (p: 75)
- C99 标准 (ISO/IEC 9899:1999)
- 6.4.9 注释 (p: 66)
- C89/C90 标准 (ISO/IEC 9899:1990)
- 3.1.9 注释
[编辑] 另请参见
| C++ 文档 关于 注释
|
