003软件编程规范总则

《003软件编程规范总则》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、中光通信软件编程规范总则Q/ZG93.105.003.010软件编程规范总则（试行）第一版2002-3-21仅供内部使用8中光通信软件编程规范总则Q/ZG93.105.003.010修订记录日期修订版本描述作者2002/3/21V1.0软件编码规范仅供内部使用8中光通信软件编程规范总则Q/ZG93.105.003.010软件编程规范总则(V1.0)为了提高源程序的质量和可维护性，最终提高ZG研发中心的软件产品生产力，我们有必要对研发中心的软件产品的源程序的编写风格作出统一的规范约束。本规范总则是独立于具体语言的编程规则的总

2、的原则，针对不同编程语言或应用环境的编程规范在遵守本规范总则的基础上，还必须遵守相应语言和就用环境的编程规范。本规范总则适用于公司所有产品以及对外合作委托开发产品的软件源程序。本规范总则的内容包括：排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量保证、代码编译、单元测试、程序版本与维护等。本规范总则的示例都以C语言为背景，采用以下的术语描述：★规则：编程时强制必须遵守的原则。★建议：编程时必须加以考虑的原则。★说明：对此规则或建议进行必要的解释。★示例：对此规则或建议从正、反两个方面给出例子。仅供内部使用8中光

3、通信软件编程规范总则Q/ZG93.105.003.010目录1排版52注释9规则2-7：避免在注释中使用缩写，特别是非常用缩写。103标识符命名144可读性165变量、结构186函数、过程23建议6-14：避免使用无意义或含义不清的动词为函数命名。26建议6-15：函数的返回值要清楚、明了，让使用者不容易忽视错误情况。277可测性308程序效率349质量保证3810代码编辑、编译、审查4411代码测试、维护4612宏48仅供内部使用8中光通信软件编程规范总则Q/ZG93.105.003.0101排版规则1-1：程序块要采用

4、缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。规则1-2：相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if(!valid_ni(ni)){...//programcode}repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;应如下书写if(!valid_ni(ni)){...//programcode}repssn_ind=ssn_data[index].repssn_ind

5、ex;repssn_ni=ssn_data[index].ni;规则1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：perm_count_msg.head.len=NO7_TO_STAT_PERM_COUNT_LEN+STAT_SIZE_PER_FRAM*sizeof(_UL);act_task_table[frame_id*STAT_TASK_CHECK_NUMBER+index].occupied=sta

6、t_poi[index].occupied;act_task_table[taskno].duration_true_or_false=SYS_get_sccp_statistic_state(stat_item);report_or_not_flag=((taskno

7、5.003.010规则1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。示例：if((taskno

8、gramcode}for(i=0,j=0;(i