序
总 则 条 款
执行情况
说明
程序都要采用如上的缩进方式。
11
¹
1-11:在两个以上的关键字、变量、常量
进行对等操作时,它们之间的操作符之前、之
后或者前后要加空格;进行非对等操作时,如
果是关系密切的立即操作符(如->),后不
应加空格。
是[ ] 否[ ] 免[ ]
2 注释
¹
2-1:一般情况下,源程序有效注释量必
须在20%以上。
是[ ] 否[ ] 免[ ]
¹
2-2:说明性文件(如头文件.h文件、.inc
文件、.def文件、编译说明文件.cfg等)头部应
进行注释,注释必须列出:版权说明、版本号、
生成日期、作者、内容、功能、与其它文件的关系、
修改日志等,头文件的注释中还应有函数功能
简要说明。
是[ ] 否[ ] 免[ ]
¹
2-3:源文件头部应进行注释,列出:版
权说明、版本号、生成日期、作者、模块目的/功能、
主要函数及其功能、修改日志等。
是[ ] 否[ ] 免[ ]
¹
2-4:函数头部应进行注释,列出:函数
的目的/功能、输入参数、输出参数、返回值、调用
关系(函数、表)等。
是[ ] 否[ ] 免[ ]
¹
2-5:边写代码边注释,修改代码同时修
改相应的注释,以保证注释与代码的一致性。
不再有用的注释要删除。
是[ ] 否[ ] 免[ ]
¹
2-6:注释的内容要清楚、明了,含义准确,
防止注释二义性。
是[ ] 否[ ] 免[ ]
¹
2-7:避免在注释中使用缩写,特别是非
常用缩写。
是[ ] 否[ ] 免[ ]
¹
2-8:注释应与其描述的代码相近,对代
码的注释应放在其上方或右方(对单条语句的
注释)相邻位置,不可放在下面,如放于上方
则需与其上面的代码用空行隔开。
是[ ] 否[ ] 免[ ]
¹
2-9:对于所有有物理含义的变量、常量,
如果其命名不是充分自注释的,在声明时都必
须加以注释,说明其物理含义。变量、常量、宏
的注释应放在其上方相邻位置或右方。
是[ ] 否[ ] 免[ ]
¹
2-10:数据结构声明(包括数组、结构、类、
枚举等),如果其命名不是充分自注释的,必须
加以注释。对数据结构的注释应放在其上方相
邻位置,不可放在下面;对结构中的每个域的
注释放在此域的右方。
是[ ] 否[ ] 免[ ]