C语言编程规范_v6.20解析.doc

C语言编程规范 1 排版 2 2 注释 5 3 标识符命名 10 5 变量、结构 15 6 函数、过程 20 7 程序效率 27 8 质量保证 32 9 代码编辑、编译、审查 38 10 宏 40  排版 1-1：程序块要采用缩进风格编写，缩进的空格数为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; 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：不允许把多个短语句写在一行中，即一行只写一条语句。 示例：如下例子不符合规范。 rect.length = 0; rect.width = 0; 应如下书写 rect.length = 0; rect.width = 0; 1-5：if、for、do、while、case、switch、default 等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。 示例：如下例子不符合规范。 if (pUserCR == NULL) return; 应如下书写： if (pUserCR == NULL) { return; } 1-7：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。 1-8：程序块的分界符（如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 }  2 注释 2-1：一般情况下，源程序有效注释量必须在20％以上。 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 2-2：文件头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、修改日志等。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包 含在内。 /**************************************************************