软件编码规范(C).docx
54页
软件编程规范总则(C/C++)拟制: 审核: 批准:隆承志(仅供内部使用)日期： 2003-7-23日期： yyyy-mm-dd日期： yyyy-mm-dd致因尻得Dcampus Networks Co., Ltd.广州数园网络有限公司版权所有侵权必究软件编程规范总则（第一版）为了提高源程序的质量和可维护性，最终提高公司软件产品生产力，我们有必要对公司软件产 品的源程序的编写风格作出统•的规范约束本规范总则是独立于具体语言的编程规则的总的原则，针对不同编程语言或应用环境的编程规 范在遵守本规范总则的基础上，还必须遵守相应语言和就用环境的编程规范本规范总则适用于公 司所有产品以及对外合作委托开发产品的软件源程序木规范总则的内容包括：排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量 保证、代码编译、单元测试、程序版本与维护等本规范总则的示例都以C语言为背景，采用以下的术语描述：★ 规则：编程时强制必须遵守的原则★ 建议：编程时必须加以考虑的原则★ 说明：对此规则或建议进行必要的解释★ 示例：对此规则或建议从正、反两个方面给出例子修订记录日期修订版本描述作者2003-8-111.00初稿完成隆承志目录1排版 52注释 103标识符命名 174可读性 195变量、结构 216函数、过程 287可测性 378程序效率 429质量保证 4610代码编辑、编译、审查 5311代码测试、维护 5512 宏 561排版规则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：较长的语句(>8咛符)要分成多行书写，长表达式要在低优先级操作符处划分新行，操 作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读示例：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_t rue_or_f alse=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：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优 先级操作符处划分新行，操作符放在新行之首。
示例：if ((taskno < max_act_task_number)&& (n7stat_stat_item_valid (stat_item))) {・・・ // program code )for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length) && (j < NewKeyword.word_length); i++, j++){・・・ // program code )for (i = 0, j = 0;(i < first_word_length) && (j < second_word_length); i++, j++){... // program code )规则1-5：若函数或过程中的参数较长，则要进行适当的划分.示例：n7stat_str_compare((BYTE *) & stat_object, (BYTE *) & (act_task_table[taskno].stat_object), Sizeof (_STAT_OBJECT));n7stat_flash_act_duration( stat__item, frame_id *STAT_TASK_CHECK_NUMBER + index, stat_object );规则1-6：不允许把多个短语句写在一行中，即一行只写一条语句.示例：如下例子不符合规范。
rect.length = 0; rect.width = 0;应如下书写rect.length = 0;rect.width = 0;规则 1・7： if、for、do、while、case、switch> default等语句自占一行，且if、for、do、while等语 句的执行语句部分无论多少都要加括号｛｝ O示例：如下例子不符合规范if (pUserCR == NULL) return;应如下书写：if (pUserCR == NULL)(return;)规则1・8：对齐只使用空格键，不使用TAB键说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整 齐，不要使用BC作为编辑器合版本，因为BC会自动将8个空格变为一个TAB键，因此使用BC 合入的版本大多会将缩进变乱规则函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，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)规则LU:在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者 前后要加空格；进行非对等操作时，如果是关系密切的立即操作符(如一>),后不应加空格说明：采用这种松散方式编写代码的H的是使代码更加清晰由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的唐句中没有必要再留空格，如 果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加 空格，因为在C/C++语言中括号已经是最清晰的标志了在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格给操作 符留空格时不要连续留两个以上空格示例：(1)逗号、分号只在后面加空格。
int a, b, c;(2)比较操作符，赋值操作符" = "、算术操作符" + 逻辑操作符位域操作符"<<"、"八"等双目操作符的前后加空格if (current_time >= MAX_TIME_VALUE)a = b + c;a *= 2;a = b A 2;(3)"!"、"一"、(地址运算符)等单目操作符前后不加空格P = 'a'； //内容操作"*"与内容之间flag = ! isEmpty; //非操作"！"与内容之间p = &mem; //地址操作与内容之间i++； // 与内容之间(4)前后不加空格.p->id = pid; // 指针前后不加空格(5) if、for, while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显 if (a >= b && c > d)建议一行程序以小于80字符为宜,不要写得过长2注释规则2-1： 一般情况下，源程序有效注释量必须在20%以上说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太 少，注释语言必须准确、易懂、简洁规则2-2：说明性文件(如头文件.h文件、.inc文件、.det文件、编译说明文件.cfg等)头部应进行注 释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改 日志等，头文件的注释中还应有函数功能简要说明。
示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含 在内Copyright (C), 1988-1999, DCampus Network Ltd.File name: // 文件名Author: Version: Date: //作者、版本及完成日期Description: //用于详细说明此程序文件完成的主要功能，与其他模块//或函数的接口，输出值、取值范围、含义及参数间的控//制、顺序、独立或依赖等关系Others: //其它内容的说明Function List: //主要函数列表，每条记录应包括函数名及功能简要说明History: //修改历史记录列表，每条修改记录应包括修改日期、修改//者及修改内容简述1. Date:Author:Modification: 2,…规则2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的砌能、 主要函数及其功能、修改日志等.示例：下面这段源文件的头注样比较标准，当然，并不局限于此格式，但上述信息建议要包含 在内Copyright (C), 1988-1999, Dcampus Network Ltd.FileName: test.cppAuthor: Version : Date:Description: // 模块描述Version: //版本信息Function List: //主要函数及其功能1. History: //历史修改记录
