2019/11/16 C语言规范 2.注释书写规范

1.有效注释量必须在20%以上，注释语言要准确易懂简洁

2.头文件应进行注释，注释必须列出：版本说明、版本号、生成日期、作者、内容、功能、修改日志等。

3.函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。

4.编写代码边注释，修改代码的同时，修改对应的注释，保证注释与代码的一致性。没用的注释删除

5.注释内容要准确明了，不能有歧义

6.不要再注释中使用只有你自己看的懂得缩写

7.单行代码的注释要放在单行代码的上方或右方，放在上方时要与上一个语句空行隔开

8.变量、常量、宏的注释都应放在其上方或右方

9.数据结构的注释放在其上方，成员的注释放在其右方

10.全局变量要有详细的注释，包括其功能、取值范围、函数调用等（反正我自己没有标注那么多）

11.不要在代码或表达式中插入注释

12.代码注释注意格式，不要乱，影响代码观感。注释最好与所描述的代码同样的缩排，可使程序排版整齐，方便阅读理解。格式统一:/* ……     ……*/

13.注释有用的信息，没用的信息不要注释

14.对变量的定义和分支语句（条件分支、循环语句等）必须编写注释

15.switch中的case语句最好注释一下

16.语言建议使用中文，除非你的英语水平很高，表达的非常清楚

 

 

   ------参考《C语言精彩例程200例》