C、C++中的注释
1 C、C++中的注释
1.1 注释规则
C、C++中的注释规则:
- 编译器在编译过程中使用空格替换整个注释。
- 字符串字面量中的//和/* … */不代表注释符号。
- /* … */型注释不能被嵌套。
- 注释中可以使用\接续符。
看一下下面的注释是否正确?
只有最后一行的注释是错误的。
再来看一下y=x/*p
这句话,这句话想表达什么呢?
作者本意:把x除以*p的结果赋值给y。
编译器:将/*
作为一段注释的开始,把/*
后的内容当当成注释内容,直到*/
出现为止。
在编译器看来,注释和其它程序元素是平等的。因此,作为工程师不能轻视注释。
1.2 注释时需要注意的点
- 坚决避免教科书型注释,注释是用于阐述原因和意图而不是用于描述程序的运行过程。
- 坚决避免迷惑性的注释,写注释不是晒心情,必须无二义性,起到对代码进行提示的作用,避免使用缩写。
- 坚决避免忽悠型的注释,注释是对代码的提示,避免臃肿和喧宾夺主。
- 坚决避免搞笑型的注释,bug要靠自己避开。
参考资料: