软件编程规范书_tp.pdf

目 录 1 排版 2 2 注释 7 3 标识符命名 13 4 可读性 15 5 变量、结构 17 6 函数、过程 24 7 可测性 32 8 程序效率 34 9 质量保证 38 10 代码编辑、编译、审查 43 11 代码测试、维护 44 12 宏 45 软件编程规范 1 排版 1 排版 1-1：统一编辑工具，使用等宽字体，并且使用统一的配置文件。 说明：软件编程的编辑工具统一使用 SourceInsight 3.0 或者 3.5 版本，同时还有这两个 版本的配置文件，已经将字体、大小、Table 键都配置好了，直接使用即可。SourceInsight 以及配置文件见相关安装目录。 1-2：程序块要采用缩进风格编写，缩进的空格数为4个。 说明：对于由开发工具自动生成的代码可以有不一致。 1-3：程序块对齐尽量使用TAB键，TAB键的停止位置为4，8，12等，也就是缩进4字符。 说明：避免使用不同的编辑器、不同的 TAB 键值来编辑程序，编辑器版本大多会将缩进变乱。 1-4：相对独立的程序块之间、变量说明之后必须加空行。 示例：如下例子不符合规范。 if (!valid_ni(ni)) { ... // program code } repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; 应如下书写 if (!valid_ni(ni)) { ... // program code } repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; 1-5：较长的语句（100字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作 符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例： perm_count_msg.head.len = TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL ); act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied; act_task_table[taskno].duration_true_or_false = SYS_get_sccp_statistic_state( stat_item ); report_or_not_flag = ((taskno MAX_ACT_TASK_NUMBER) 仅供内部使用 2 软件编程规范 1 排版 (stat_stat_item_valid (stat_item)) (act_task_table[taskno].result_data != 0)); ¹1-6：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先 级操作符处划分新行，操作符放在新行之首。若屏幕能清楚看到行末操作符，为美观对齐，也可以将 操作符放在行末。 示例： if ((taskno max_act_task_number) (stat_stat_item_valid (stat_item))) { ... // program code } for (i = 0, j = 0; (i BufferKeyUINT16