目录 1排版 6 2注释 11 3标识符命名 18 4可读性 20 变量、结构 6函数、过程 7可测性 8程序效率 9质量保证 10代码编辑、编译、审查 2860402 11代码测试、维护 12宏
目 录 1 排版 6 2 注释 11 3 标识符命名 18 4 可读性 20 5 变量、结构 22 6 函数、过程 28 7 可测性 36 8 程序效率 40 9 质量保证 44 10 代码编辑、编译、审查 50 11 代码测试、维护 52 12 宏 53
软件编程规范总则 1排版 1排版 1-1:程序块要采用缩进风格编写,缩进的空格数为4个。 说明:对于由开发工具自动生成的代码可以有不一致。 -2:相对独立的程序块之间、变量说明之后必须加空行 示例:如下例子不符合规范 repssn ind ssn data [index]. repssn index; repssn ni ssn data[index].nii 应如下书写 if (!valid ni(ni) 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 tat poi[index]. occupied act task table[taskno] duration true or false sYs get sccp statistic state( stat item )i report or not flag =((tas kno MAX ACT TASK NUMBER 仅供内部使用3
软件编程规范总则 1 排版 仅供内部使用 3 1 排版 ¹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)
软件编程规范总则 1排版 (n7stat stat item valid (stat item)) (act task table[taskno] result data I= 0))i 仅供内部使用4
软件编程规范总则 1 排版 仅供内部使用 4 && (n7stat_stat_item_valid (stat_item)) && (act_task_table[taskno].result_data != 0));
软件编程规范总则 1排版 1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低 优先级操作符处划分新行,操作符放在新行之首 例 if((tas kno max act task number &&(n7stat stat item valid (stat item))) for (i=0,1=0;(i< BufferKeyword [word index]. word lengt & (< NewKe word word length)i 1++, 3++) // program code (i first word length)&&(]< second word length) // program code 1-5:若函数或过程中的参数较长,则要进行适当的划分。 示例 n7stat str compare((BYTE *) stat object (BYTE *)&(act task table [taskno] stat object) n7stat flash act duration( stat item, frame id *STAT TASK CHECK NUMBER 1-6:不允许把多个短语句写在一行中,即一行只写一条语句。 例:如下例子不符合规范 rect length =0; rect width =0 应如下书写 仅供内部使用5
软件编程规范总则 1 排版 仅供内部使用 5 ¹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; 应如下书写
软件编程规范总则 1排版 rect length =0 rect, width 1-7:if、for、do、whie、case、 switch、 defau1t等语句自占一行,且if、for、 do、 while等语句的执行语句部分无论多少都要加括号0。 示例:如下例子不符合规范。 if (pUserCR = NUll) return 应如下书写: if (pUserCR = NULL) returni 1-8:对齐只使用空格键,不使用TAB键 说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局 不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键 因此使用BC合入的版本大多会将缩进变乱。 1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case 语句下的情况处理语句也要遵从语句缩进要求 1-10:程序块的分界符(如c/c++语言的大括号‘’和“})应各独占一行并且位于同一 列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以 及主f、for、do、whi]e、 switch、case语句中的程序都要采用如上的缩进方式 示例:如下例子不符合规范。 // program code if(..) // program code 仅供内部使用6
软件编程规范总则 1 排版 仅供内部使用 6 rect.length = 0; rect.width = 0; ¹1-7：if、for、do、while、case、switch、default等语句自占一行，且if、for、 do、while等语句的执行语句部分无论多少都要加括号{}。 示例：如下例子不符合规范。 if (pUserCR == NULL) return; 应如下书写： if (pUserCR == NULL) { return; } ¹1-8：对齐只使用空格键，不使用TAB键。 说明：以免用不同的编辑器阅读程序时，因 TAB 键所设置的空格数目不同而造成程序布局 不整齐，不要使用 BC 作为编辑器合版本，因为 BC 会自动将 8 个空格变为一个 TAB 键， 因此使用 BC 合入的版本大多会将缩进变乱。 ¹1-9：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求。 ¹1-10：程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一 列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以 及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 示例：如下例子不符合规范。 for (...) { ... // program code } if (...) { ... // program code }
软件编程规范总则 1排版 void example fun( void 应如下书写 for(...) if(...) // program code void example fun( void // program code 1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或 者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如一>),后不应加空 格 说明:采用这种松散方式编写代码的目的是使代码更加清晰 由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格, 如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间 不必加空格,因为在c/C++语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给 操作符留空格时不要连续留两个以上空格 示例: (1)逗号、分号只在后面加空格。 仅供内部使用
软件编程规范总则 1 排版 仅供内部使用 7 void example_fun( void ) { ... // program code } 应如下书写。 for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code } ¹1-11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或 者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空 格。 说明：采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格， 如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间 不必加空格，因为在 C/C++语言中括号已经是最清晰的标志了。 在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给 操作符留空格时不要连续留两个以上空格。 示例： (1) 逗号、分号只在后面加空格。 int a, b, c;
软件编程规范总则 1排版 2)比较操作符,赋值操作符”="、"+=",算术操作符"+"、"",逻辑操作符· "&",位域操作符" MAX TIME VALUE 2 (3)"!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格 //内容操作""与内容之间 flag=! isEmpty;//非操作"!"与内容之间 /地址操作"&"与内容之间 i++ /"++","--"与内容之间 (4)”->"、"."前后不加空格 p->id=pid;//"->"指针前后不加空格 (5)if、for、 while、 switch等与后面的括号间应加空格,使if等关键字更为突出、 明显。 if(a >=b && d) 11:一行程序以小于80字符为复,不要写得过长。 仅供内部使用8
软件编程规范总则 1 排版 仅供内部使用 8 (2)比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、 "&"，位域操作符"= MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2; (3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。 *p = 'a'; // 内容操作"*"与内容之间 flag = !isEmpty; // 非操作"!"与内容之间 p = &mem; // 地址操作"&" 与内容之间 i++; // "++","--"与内容之间 (4)"->"、"."前后不加空格。 p->id = pid; // "->"指针前后不加空格 (5) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、 明显。 if (a >= b && c > d) ½1-1：一行程序以小于80字符为宜，不要写得过长
软件编程规范总则 2注释 2注释 12-1:一般情况下,源程序有效注释量必须在20%以上。 说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不 能太少,注释语言必须准确、易懂、简洁 2-2:说明性文件(如头文件h文件、,inc文件、,def文件、编译说明文件cfg等)头部应 进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的 关系、修改日志等,头文件的注释中还应有函数功能简要说明 示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要 包含在内。 /*★大大大大大大大大大大大大大大大大★大大大大大★大大大大大大大大大大大大大大大大大大大大大大大大 Copyright (C),1988-1999, Huawei Tech. Co, Ltd File name //文件名 Author Date://作者、版本及完成日期 Description://用于详细说明此程序文件完成的主要功能,与其他模块 /或函数的接口,输出值、取值范围、含义及参数间的控 /制、顺序、独立或依赖等关系 /其它内容的说明 Function List://主要函数列表,每条记录应包括函数名及功能简要说明 History: /修改历史记录列表,每条修改记录应包括修改日期、修改 /者及修改内容简述 12-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、 主要函数及其功能、修改日志等。 示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要 包含在内。 仅供内部使用9
软件编程规范总则 2 注释 仅供内部使用 9 2 注释 ¹2-1：一般情况下，源程序有效注释量必须在20％以上。 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不 能太少，注释语言必须准确、易懂、简洁。 ¹2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应 进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的 关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要 包含在内。 /************************************************* Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. File name: // 文件名 Author: Version: Date: // 作者、版本及完成日期 Description: // 用于详细说明此程序文件完成的主要功能，与其他模块 // 或函数的接口，输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1. .... History: // 修改历史记录列表，每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. ... *************************************************/ ¹2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、 主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要 包含在内
软件编程规范总则 2注释 /大大大大大大大大大大大大大大大大大大★大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大 Copyright (C),1988-1999, Huawei Tech. Co., Ltd. FileName: test. cpp Author Description 模块描述 Version 版本信息 Function List://主要函数及其功能 History /历史修改记录 David 96/10/12 build this moudle 大★大大大大大★★大★★大★大大★大大大大大大大大★★大大大大★大大大大大★★大大★大大大大★大大大大大★大大大★★大 说明: Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与 其它文件关系等。 History是修改历史记录列表,每条修改记录应包括修改日期、修改 者及修改内容简述 2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用 关系(函数、表)等 示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含 在内 /*大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大 Function /函数名称 Description ∥/函数功能、性能等的描述 Calls /被本函数调用的函数清单 Called By /调用本函数的函数清单 Table Accessed://被访问的表(此项仅对于牵扯到数据库操作的程序) Table Updated://被修改的表(此项仅对于牵扯到数据库操作的程序) Input: /输入参数说明,包括每个参数的作 /用、取值说明及参数间关系。 Output //对输出参数的说明 /函数返回值的说明 /其它说明 大★大大大大★大大大大★大大大大大大大大大大大大大大大大大大大大★大★大大大大大大大/ 仅供内部使用10
软件编程规范总则 2 注释 仅供内部使用 10 /************************************************************ Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. FileName: test.cpp Author: Version : Date: Description: // 模块描述 Version: // 版本信息 Function List: // 主要函数及其功能 1. ------- History: // 历史修改记录 David 96/10/12 1.0 build this moudle ***********************************************************/ 说明：Description 一项描述本文件的内容、功能、内部各部分之间的关系及本文件与 其它文件关系等。History 是修改历史记录列表，每条修改记录应包括修改日期、修改 者及修改内容简述。 ¹2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用 关系（函数、表）等。 示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含 在内。 /************************************************* Function: // 函数名称 Description: // 函数功能、性能等的描述 Calls: // 被本函数调用的函数清单 Called By: // 调用本函数的函数清单 Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序） Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序） Input: // 输入参数说明，包括每个参数的作 // 用、取值说明及参数间关系。 Output: // 对输出参数的说明。 Return: // 函数返回值的说明 Others: // 其它说明 *************************************************/