代码编程规范剖析.doc

软件代码编程规范 制订审A00 新版本发行 2008-12-02 刘志敏 目的 标准化软件工作流程 规范编程代码条理清晰，提高程序扩展性 提高软件发布质量,减少出错几率 规范注释和代码风格简单易读,方便格式化处理便于后期移交和维护 适用范围 软件系统架构师、软件工程师、软件技术总监/副总监、软件主管 代码规范 排版 程序块要采用缩进风格编写，缩进采用TAB键方式。（TAB键设置的空格数为4个）说明：对于由开发工具自动生成的代码可以有不一致 较长的语句（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)); if ((taskno max_act_task_number) (n7stat_stat_item_valid (stat_item))) { ... // program code } n7stat_str_compare((BYTE *) stat_object, (BYTE *) (act_task_table[taskno].stat_object), sizeof (_STAT_OBJECT)); 不允许把多个短语句写在一行中，即一行只写一条语句 示例：如下例子不符合规范 rect.length = 0; rect.width = 0; 应如下书写 rect.length = 0; rect.width = 0; if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{} 示例：如下例子不符合规范 if (pUserCR == NULL) return; 应如下书写： if (pUserCR == NULL) { return; } 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求 程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式. 示例：如下例子不符合规范 for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code } 应如下书写。 for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code } 在两个以上的关键字、变量、常量进行对等操作时，它们之间