注释符号

1 注释的第一印象

2 似是而非的问题

下面的注释是正确的么？

#include <stdio.h>int main(){    int/*...*/i;    char* s = "abcdefgh      //hijklmn";    //Is it a \    valid comment?    in/*...*/t i;    return 0;}/* 只有最后一句注释是错误的。 */

3 注释规则

• 编译器在编译过程中使用空格替换整个注释。
• 字符串字面量中的//和/…/不代表注释符号。
• /…/型注释不能被嵌套（注意：注释不能嵌套，/会跟最近的一个/匹配，从而产生错误）。

4 有趣的问题

5 不良注释举例

5.1 教科书型注释

5.2 迷惑型的注释

5.3 忽悠型注释

5.4 搞笑型注释

6 小结

• 注释应该准确易懂，防止二义性，错误的注释有害无利。
• 注释是对代码的提示，避免臃肿和喧宾夺主。
• 一目了然地代码避免加注释。
• 不要用缩写来写注释，这样可能会产生误解。
• 注释用于阐述原因和意图而不是描述程序的运行过程。