注释符号

注释中的一些规则：

• 编译器会在编译过程删除注释，但不是简单的删除而是用空格代替
• 编译器认为双引号括起来内容都是字符串，双斜杠和/* */也不例外。
• “/……/”型注释不能被嵌套，即在多行注释中不要加入其他的注释符号。
• 在一行注释后加上\号，表明下一行也是注释

    int/*...*/i;
    char* s = "abcdefgh   /*  */ //hijklmn";

    //Is it a \
    valid comment?

    in/*...*/t i;

上面的例子中，最后一个注释是错误的。

出色的注释要求：

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