软件编程规范

1 排版

1.1 赋值操作符、算术操作符、逻辑操作符、位域操作符等双目操作符的前后加空格

1.2 单目操作符前后不加空格

1.3 if、for、while、switch 与后面的括号加空格

 

2 注释

2.1 源程序有效注释量必须在20%以上

2.2 保证代码与注释的一致性

2.3 全局变量要有详细的注释

2.4 说明性文件

        如.h文件、.inc文件、.def文件等，头部应进行注释，注释必须列出：排版说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等。

2.5 源文件头部的注释同上

2.6 注释的格式尽量统一

 

3 标识符命名

3.1 标识符的命名要清晰、明了，有明确含义

3.2 命名中若使用特殊约定或缩写，要有注释说明

3.3 命名风格要保持一致

3.4 除了编译开关/头文件等特殊应用，应避免使用以下划线开始和结尾的定义

 

4 可读性

4.1 注意运算符的优先级，并用括号明确表达式的操作顺序

4.2 避免使用不易理解的数字，用有意义的标识来代替

 

5 变量、结构

5.1 去掉没必要的公共变量

5.2 仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系

5.3 明确公共变量与操纵此公共变量的函数或过程的关系

5.4 严禁使用未经初始化的变量作为右值

5.5 使用严格形式定义的、可移植的数据类型，尽量不要使用与具体硬件或软件环境关系密切的变量

5.6 结构的设计要尽量考虑向前兼容和以后的版本升级，