排版要求
1、程序块要采用缩进风格编写,缩进的空格数为4个。
2、相对独立的程序块之间、变量说明之后必须加空行。
3、较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
4、循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
5、若函数或过程中的参数较长,则要进行适当的划分。
注释
1、一般情况下,源程序有效注释量必须在20%以上。
2、在头文件中加入公司标识。
3、说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
4、源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
5、函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
标识符命名
1、标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。
2、命名中若使用特殊约定或缩写,则要有注释说明。
3、对于变量命名,禁止取单个字符(如i、j、k…),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
4、命名规范必须与所使用的系统风格保持一致,并在同一项目中统一。
可读性
1、注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。
2、避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替。
变量
1、去掉没必要的公共变量。
2、仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。
3、明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建等。
4、当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。
5、防止局部变量与公共变量同名。
函数
1、对所调用函数的错误返回码要仔细、全面地处理。
2、明确函数功能,精确(而不是近似)地实现函数设计。
3、在同一项目组应明确规定对接口函数参数的合法性检查应由函数的调用者负责还是由接口函数本身负责,缺省是由函数调用者负责。
可测性
1、在同一项目组或产品组内,要有一套统一的为集成测试与系统联调准备的调测开关及相应打印函数,并且要有详细的说明。
2、在同一项目组或产品组内,调测打印出的信息串的格式要有统一的形式。信息串中至少要有所在模块名(或源文件名)及行号。
3、编程的同时要为单元测试选择恰当的测试点,并仔细构造测试代码、测试用例,同时给出明确的注释说明。测试代码部分应作为(模块中的)一个子模块,以方便测试代码在模块中的安装与拆卸(通过调测开关)。
4、在进行集成测试/系统联调之前,要构造好测试环境、测试项目及测试用例,同时仔细分析并优化测试用例,以提高测试效率。
程序效率
1、在保证软件系统的正确性、稳定性、可读性及可测性的前提下,提高代码效率。
2、局部效率应为全局效率服务,不能因为提高局部效率而对全局效率造成影响。
3、通过对系统数据结构的划分与组织的改进,以及对程序算法的优化来提高空间效率。
416

被折叠的 条评论
为什么被折叠?



