C语言符号：出色注释的基本要求

C语言符号：****出色注释的基本要求****

1.注释应当准确、易懂，防止有二义性。

2.****边写代码边注释，****修改代码同时修改相应的注释，以保证注释与代码的一致性。

3.注释是对代码的“提示”，而不是文档。

4.一目了然的语句不加注释。

5.对于全局数据（全局变量、常量定义等）必须要加注释。

6.注释采用英文，尽量避免在注释中使用缩写，

因为不一定所有的编译器都能显示中文，别人打开你的代码，你的注释也许是一团乱

码。

7.注释的位置应与被描述的代码相邻，可以与语句在同一行，也可以在上行，

同一结构中不同域的注释要对齐。

8.当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，

9.注释的缩进要与代码的缩进一致。

10.注释代码段时应注重“为何做（why）”，而不是“怎么做（how）”。

11.数值的单位一定要注释。

12.对变量的范围给出注释。

13.对一系列的数字编号给出注释，尤其在编写底层驱动程序的时候（比如管脚

编号

14.对于函数的入口出口数据给出注释。