《华为编程规范和范例》由会员分享，可在线阅读，更多相关《华为编程规范和范例（59页珍藏版）》请在金锄头文库上搜索。
1、目目 录录 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 排版仅供内部使用 2 1 排版排版 1-1：程序块要采用缩进风格编写，缩进的空格数为：程序块要采用缩进风格编写，缩进的空格数为4个。个。 说明：对于由开发工具自动生成的代码可以有不一致。 1-2：相对独立的程序块之间、变量说明之后必须加空行。：相对独立的程序块之间、变量说明之后必须加空行。 示例：如下例子不符合规范。
2、 if (!valid_ni(ni) . / program code repssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_dataindex.ni; 应如下书写 if (!valid_ni(ni) . / program code repssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_dataindex.ni; 1-3：较长的语句（：较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语
3、句可读。字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例： perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL ); act_task_tableframe_id * STAT_TASK_CHECK_NUMBER + index.occupied = stat_poiindex.occupied; act_task_tabletaskno.duration_true_or_false
4、 = SYS_get_sccp_statistic_state( stat_item ); report_or_not_flag = (taskno ），后不应加空格。），后不应加空格。 说明：采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的， 所以， 在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格， 多重括号间不必加空格，因为在 C/C+语言中括号已经是最清晰的标志了。 在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。 示例： (
5、1) 逗号、分号只在后面加空格。 int a, b, c; 软件编程规范总则 1 排版仅供内部使用 7 (2)比较操作符, 赋值操作符“=“、 “+=“，算术操作符“+“、“%“，逻辑操作符“ a *= 2; a = b 2; (3)“!“、“、“+“、“-“、“ / 内容操作“*“与内容之间 flag = !isEmpty; / 非操作“!“与内容之间 p = / 地址操作“ / “+“,“-“与内容之间 (4)“-“、“.“前后不加空格。 p-id = pid; / “-“指针前后不加空格 (5) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出
6、、明显。 if (a = b repssn_ni = ssn_dataindex.ni; 例 2： repssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_dataindex.ni; /* get replicate sub system index and net indicator */ 应如下书写 /* get replicate sub system index and net indicator */ repssn_ind = ssn_dataindex.repssn_index; repssn_ni = ssn_datain
7、dex.ni; 2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。 示例： /* active statistic task number */ #define MAX_ACT_TASK_NUMBER 1000 软件编程规范总则 2 注释仅供内部使用 11 #define MAX_ACT_TASK_NUMBER 1000 /* active
8、statistic task number */ 2-10：数据结构声明：数据结构声明(包括数组、结构、类、枚举等包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。 示例：可按如下形式说明枚举/数据/联合结构。 /* sccp interface with sccp user primitive message name */ enum SCCP_US
9、ER_PRIMITIVE N_UNITDATA_IND, /* sccp notify sccp user unit data come */ N_NOTICE_IND, /* sccp notify user the No.7 network can not */ /* transmission this message */ N_UNITDATA_REQ, /* sccp users unit data transmission request*/ ; 2-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。：全局变量要有较详细的注释，包
10、括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。 示例： /* The ErrorCode when SCCP translate */ /* Global Title failure, as follows */ / 变量作用、含义 /* 0 SUCCESS 1 GT Table error */ /* 2 GT error Others no use */ / 变量取值范围 /* only function SCCPTranslate() in */ /* this modual can modify it, and other */ /* module can vi
11、sit it through call */ /* the function GetGTTransErrorCode() */ / 使用方法 BYTE g_GTTranErrorCode; 2-12：注释与所描述内容进行同样的缩排。：注释与所描述内容进行同样的缩排。 说明：可使程序排版整齐，并方便注释的阅读与理解。 示例：如下例子，排版不整齐，阅读稍感不方便。 void example_fun( void ) /* code one comments */ CodeBlock One 软件编程规范总则 2 注释仅供内部使用 12 /* code two comments */ CodeBloc
12、k Two 应改为如下布局。 void example_fun( void ) /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two 2-13：将注释与其上面的代码用空行隔开。：将注释与其上面的代码用空行隔开。 示例：如下例子，显得代码过于紧凑。 /* code one comments */ program code one /* code two comments */ program code two 应如下书写 /* code one comments */ program code on
13、e /* code two comments */ program code two 2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。 说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。 2-15：对于：对于switch语句下的语句下的case语句，如果因为特殊情况需要处理完一个语句，如果因为特殊情况需要处理完一个case后进入下一个后进入下一个case处理，必须在该处理，必须在该case语句处理完、下一个语句处理完、下一个case语句前加上
14、明确的注释。语句前加上明确的注释。 说明：这样比较清楚程序编写者的意图，有效防止无故遗漏 break 语句。 软件编程规范总则 2 注释仅供内部使用 13 示例（注意斜体加粗部分） ： case CMD_UP: ProcessUp(); break; case CMD_DOWN: ProcessDown(); break; case CMD_FWD: ProcessFwd(); if (.) . break; else ProcessCFW_B(); / now jump into case CMD_A case CMD_A: ProcessA(); break; case CMD_B: Pr
15、ocessB(); break; case CMD_C: ProcessC(); break; case CMD_D: ProcessD(); 软件编程规范总则 2 注释仅供内部使用 14 break; . 2-1：避免在一行代码或表达式的中间插入注释。：避免在一行代码或表达式的中间插入注释。 说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。 2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。 说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。 2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。：在代码的功能、意图层次上进行注释，提供有用、额外的信息。 说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。 示例：如下注释意义不大。 /* if receive_flag is TRUE */ if (receive_flag) 而如下的注释则给出了额外有用的信息。 /* if mtp receive a message from links */ if (receive_flag) 2-4
