C++编程规范.docVIP

(内部资料，注意保密) 制作单位： 杭州时代银通软件有限公司 文档编号: EYT2004--001 出处: 本文由编辑 说明 感谢为编程规范作出辛勤劳动的作者！ 本规范总则的内容包括：排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量保证、代码编译、单元测试、程序版本与维护等。 本规范总则的示例都以C/C++语言为背景，采用以下的术语描述： ★ 规则 1：编程时强制必须遵守的原则。 ★ 建议 ?：编程时必须加以考虑的原则。 ★ 说明：对此规则或建议进行必要的解释。 ★ 示例：对此规则或建议从正、反两个方面给出例子。 ★ 红色：特别针对C++而言的要求。 目 录 1. 排版 4 2. 注释 10 3. 标识符命名 18 4. 可读性 21 5. 变量、结构和类 23 6. 函数、过程 31 7. 可测性 41 8. 程序效率 46 9. 质量保证 52 10. 代码编辑、编译、审查 60 11. 代码测试、维护 62 12. 常量和宏 63 排版 1-14个。 说明：对于由开发工具自动生成的代码可以有不一致。 建议：尽量修改开发工具的编辑选项，将缩进的空格数改为4个。 1-2：相对独立的程序块之间、变量说明，类声明，之后必须加空行。 示例：如下例子不符合规范。 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; 示例：函数内部的空行 // 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } 示例：函数之间的空行 // 空行 void Function1(…) { … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … } 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 = 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) (n7stat_stat_item_valid (stat_item)) (act_task_table[taskno].result_data != 0)); 1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。 示例：较长判断，循环语句的断行 if ((taskno max_act_task_number) (n7stat_stat_item_valid (stat_item))) { ... // program code } for (i = 0, j = 0; (i BufferKeyword[word_index].word_length) (j NewKeyword.word_length); i++, j++)