C 语言注释

注释面向开发者阅读，编译器会直接忽略这部分内容。注释不会影响程序运行，却直接决定代码是否易于理解，哪怕是时隔许久、回头维护代码的自己。我们先从基础写法开始介绍。

什么是注释

注释是写在代码里、被编译器忽略的说明文字。它不影响程序运行，只帮助人理解代码。写不写程序都能跑，但注释是专业代码的基本素养。

单行注释

单行注释用双斜杠 // 开头，从 // 到这一行结束的内容都是注释：

#include <stdio.h>

int main() {
    // 打印信息
    printf("Hello C");
    return 0;
}

输出：

Hello C

也可以放在语句后面，同一行内解释这一句在干嘛：

printf("Hello C");  // 打印信息

多行注释

多行注释用 /* ... */ 包裹，可以跨多行。注意它不能嵌套，也就是说注释里不能再包含 /* */：

/*
要注释
的代码
*/
printf("Hello C");  // 打印信息

完整示例：

#include <stdio.h>

int main() {
    /* 打印信息
       多行注释 */
    printf("Hello C");
    return 0;
}

输出：

Hello C

注释的用法习惯

• 解释为什么而不是是什么：代码本身已经说明了它做什么，注释更适合说明为什么这么做、有什么坑。
• 给函数和复杂逻辑写文档：函数开头的注释说明参数、返回值、注意事项。
• 临时屏蔽代码：调试时用注释把一段代码关掉，比删掉再找回方便。
• 别写废话：int i; // 声明 i 这种注释毫无信息量，不如不写。

注释不存在刻板的标准规范，多看他人代码、坚持动手书写，慢慢就能找到合适的尺度。拿不定主意时不妨自问：时隔两个月再来阅读这段代码，能否一眼理清逻辑。如果心存疑虑，就补充一行注释。