华为规范化编程,很好的编程原则.pdf

华为规范化编程的编程原则 华为规范化编程的编程原则是指在软件开发过程中，为了提高代码的可读性、可维护性和可靠性，而制定的编程规则和规范。这些规则和规范旨在使代码更加简洁、易读、易维护和高效。 1. 排版 * 程序块要采用缩进风格编写，缩进的空格数为4个。 * 相对独立的程序块之间、变量说明之后必须加空行。 * 较长的语句要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 例如： ```c 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)); ``` 2. 注释 * 在代码中添加注释，以便他人快速理解代码的逻辑和意图。 * 注释应该简洁明了，避免使用过长的注释。 例如： ```c // 计算perm_count_msg.head.len perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL ); ``` 3. 标识符命名 * 变量、函数和类的命名应该遵循一定的规则和规范。 * 命名应该简洁明了，易于理解和记忆。 例如： ```c int maxActTaskNumber; // 最大活动任务数 ``` 4. 可读性 * 代码应该易于阅读和理解。 * 应该使用适当的缩进和空格来提高代码的可读性。 例如： ```c if ((taskno < maxActTaskNumber) && (n7stat_stat_item_valid (stat_item))) { // 代码逻辑 } ``` 5. 变量、结构 * 变量和结构体的定义应该遵循一定的规则和规范。 * 应该使用适当的命名和注释来提高代码的可读性和可维护性。 例如： ```c typedef struct { int id; char name[20]; } Student; ``` 6. 函数、过程 * 函数和过程的定义应该遵循一定的规则和规范。 * 应该使用适当的命名和注释来提高代码的可读性和可维护性。 例如： ```c void n7stat_str_compare(BYTE *stat_object, BYTE *act_task_stat_object, int len) { // 代码逻辑 } ``` 7. 可测性 * 代码应该易于测试和维护。 * 应该使用适当的单元测试和集成测试来确保代码的正确性。 例如： ```c void test_n7stat_str_compare() { // 测试代码逻辑 } ``` 8. 程序效率 * 代码应该高效地执行。 * 应该使用适当的算法和数据结构来提高代码的执行效率。 例如： ```c void n7stat_flash_act_duration(StatItem stat_item, int frame_id, int index) { // 代码逻辑 } ``` 9. 质量保证 * 代码应该高质量地编写。 * 应该使用适当的代码 review 和测试来确保代码的质量。 例如： ```c void code_review() { // 代码 review 逻辑 } ``` 10. 代码编辑、编译、审查 * 代码应该经过严格的编辑、编译和审查。 * 应该使用适当的工具和方法来确保代码的正确性和可靠性。 例如： ```c void compile_code() { // 编译代码逻辑 } ``` 11. 代码测试、维护 * 代码应该经过严格的测试和维护。 * 应该使用适当的工具和方法来确保代码的正确性和可靠性。 例如： ```c void test_code() { // 测试代码逻辑 } ``` 华为规范化编程的编程原则旨在提高代码的可读性、可维护性和可靠性，以提高软件开发的效率和质量。