C++编码规范规范教程.doc

C/C++编码规范 广州从兴电子开发有限公司 GUANGZHOU SUNRISE ELECTRONICS DEVELOPMENT CO., LTD 引言 为了提高源程序的质量和可维护性，最终提高公司软件产品生产力，我们有必要对公司软件产品的源程序的编写风格作出统一的规范约束。 本规范总则的内容包括：排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量保证等。本规范采用以下的术语描述： 规则：编程时强制必须遵守的原则。 说明：对此规则或建议进行必要的解释。 示例：对此规则或建议从正、反两个方面给出例子。 排版 程序块要采用缩进风格编写，缩进允许4个空白字符或者一个TAB键，同一个模块的风格必须一致。(建议) 建议使用4个空白字符，如使用TAB键，则应该在环境中也设置为4个空白。 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。(建议) 注释与所描述内容进行同样的缩排。(建议) 说明：可使程序排版整齐，并方便注释的阅读与理解。 错误示例： void example_fun() { /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two } 应改为如下布局。 void example_fun() { /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two } 相对独立的程序块之间、变量说明之后必须加空行。(建议) 错误示例： 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; 较长的语句要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读，下一行至少有一个缩进。(建议) 正确示例： 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)); 若函数或过程中的参数较长，则要进行适当的划分，按逗号分行。(强制) 正确示例： 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; 程序块的分界符（如C/C++语言的大括号‘{’和‘}’），允许有两种方式，独占一行并且位于同一列，同时与引用它们的语句左对齐；或者放在行的结尾。在函数体的开始、类的定义、