软件编程规范和范例.docVIP

目 录 1. 排版 2 1.1. 公共部分 2 1.2. Windows 5 1.3. 嵌入式 6 2. 注释 8 2.1. 公共部分 8 2.2. Windows 12 2.3. 嵌入式 13 3. 标识符命名 14 3.1. 公共部分 14 3.2. Windows 15 3.3. 嵌入式 16 4. 可读性 17 4.1. 公共部分 17 4.2. Windows 18 5. 变量、结构 20 5.1. 公共部分 20 5.2. Windows 26 6. 函数、过程 27 6.1. 公共部分 27 6.2. Windows 36 6.3. 嵌入式 36 7. 可测性 37 8. 程序效率 42 8.1. 公共部分 42 9. 质量保证 47 9.1. 公共部分 47 9.2. Windows 51 9.3. 嵌入式 51 10. 代码编辑、编译、审查 52 11. 代码测试、维护 54 12. 宏 55 12.1. 公共部分 55 12.2. Windows 56 13. 附录 57 13.1. 附录1 缩写表 57 13.2. 附录2 匈牙利命名法 58 排版 公共部分 1-1：程序块要采用缩进风格编写，缩进为Tab(设定为4个字符)或者4个空格。同一个项目必须保持一致. 说明：对于由开发工具自动生成的代码可以有不一致。 1-2：较长的语句（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; report_or_not_flag = ((taskno MAX_ACT_TASK_NUMBER) (N7StatItemValid(stat_item)) (act_task_table[taskno].result_data != 0)); 1-3：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。 示例： if ((taskno max_act_task_number) (taskid != 0) (N7StatItemValid(stat_item))) { ... // program code } for (i = 0, j = 0; (i buffer_keyword[word_index].word_length) (j new_keyword.word_length); i++, j++) { ... // program code } for (i = 0, j = 0; (i first_word_length) (j second_word_length); i++, j++) { ... // program code } 1-4：若函数或过程中的参数较长，则要进行适当的划分。 示例： N7StatStrCompare((BYTE *) stat_object, (BYTE *) (act_task_table[taskno].stat_object), sizeof (_STAT_OBJECT)); N7StatFlashActDuration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER + index, stat_object ); 1-5：不允许把多个短语句写在一行中，即一行只写一条语句。 示例：如下例子不符合规范。 rect.length = 0; rect.width = 0; 应如下书写 rect.length = 0; rect.width = 0; 1-6：if、for、do、while、case、switch、default等语句自占一行，且if、for、do、whi