概述
1.
y = x/*p,这是表示x 除以p 指向的内存里的值,把结果赋值为y?我们可以在编译器
上测试一下,编译器提示出错。
实际上,编译器把/*当作是一段注释的开始,把/*后面的内容都当作注释内容,直到出
现*/为止。这个表达式其实只是表示把x 的值赋给y,/*后面的内容都当作注释。但是,由
于没有找到*/,所以提示出错。
我们可以把上面的表达式修改一下:
y = x/ *p
或者
y = x/(*p)
这样的话,表达式的意思就是x 除以p 指向的内存里的值,把结果赋值为y 了。
也就是说只要斜杠(/)和星号(*)之间没有空格,都会被当作注释的开始。这一点一
定要注意。
出色注释的基本要求
【规则2-1】注释应当准确、易懂,防止有二义性。错误的注释不但无益反而有害。
【规则2-2】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
不再有用的注释要及时删除。
【规则2-3】注释是对代码的“提示”,而不是文档。程序中的注释应当简单明了,注释太
多了会让人眼花缭乱。
【规则2-4】一目了然的语句不加注释。
例如:i++; /* i 加1 */
多余的注释
【规则2-5】对于全局数据(全局变量、常量定义等)必须要加注释。
【规则2-6】注释采用英文,尽量避免在注释中使用缩写,特别是不常用缩写。
因为不一定所有的编译器都能显示中文,别人打开你的代码,你的注释也许是一团乱
码。还有,你的代码不一定是懂中文的人阅读。
【规则2-7】注释的位置应与被描述的代码相邻,可以与语句在同一行,也可以在上行,但
不可放在下方。同一结构中不同域的注释要对齐。
【规则2-8】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于
阅读。
【规则2-9】注释的缩进要与代码的缩进一致。
【规则2-10】注释代码段时应注重“为何做(why)”,而不是“怎么做(how)”。
说明怎么做的注释一般停留在编程语言的层次,而不是为了说明问题。尽力阐述“怎么做”
的注释一般没有告诉我们操作的意图,而指明“怎么做”的注释通常是冗余的。
【规则2-11】数值的单位一定要注释。
注释应该说明某数值的单位到底是什么意思。比如:关于长度的必须说明单位是毫米,
米,还是千米等;关于时间的必须说明单位是时,分,秒,还是毫秒等。
【规则2-12】对变量的范围给出注释。
【规则2-13】对一系列的数字编号给出注释,尤其在编写底层驱动程序的时候(比如管脚
编号)。
【规则2-13】对于函数的入口出口数据给出注释。
关于函数的注释在函数那章有更详细的讨论。
2.
我们知道双引号引起来的都是字符串常量,单引号引起来的都是字符常量。但初学者
还是容易弄错这两点。比如:‘a’和“a”完全不一样,在内存里前者占1 个byte,后者占2
个byte。""内部自己添加了一个'