1、华为软件编程规范和范例一= 排版 =. 二=注释=. 三= 标识符命名=. 四= 可读性=. 五= 变量、结构=. 六= 函数、过程=. 七= 可测性=. 八= 程序效率=. 九= 质量保证=. 十= 代码编辑、编译、审查=. 十一= 代码测试、维护=. 十二= 宏=. 一 = 排版 = 1-1：程序块要采用缩进风格编写，缩进的空格数为 4 个说明：对于由开发工具自动生成的代码可以有不一致。1-2：相对独立的程序块之间、变量说明之后必须加空行示例：如下例子不符合规范。Int ni;if (!valid_ni(ni). / program coderepssn_ind = ssn_dataind
2、ex.repssn_index;repssn_ni = ssn_dataindex.ni; 应如下书写Int ni;if (!valid_ni(ni). / program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;1-3：较长的语句（80 字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读示例：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_
3、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= SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = (taskno ），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句
4、中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面) 不需要加空格，多重括号间不必加空格，因为在 C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例：(1) 逗号、分号只在后面加空格。int a, b, c; (2)比较操作符, 赋值操作符“=“、 “+=“，算术操作符“+“、“%“，逻辑操作符“a *= 2;a = b 2; (3)“!“、 “、“+“、“-“、“ / 内容操作“*“与内容之间flag = !isEmpty; / 非操作“!“与内容之间p =
5、/ 地址操作“ / “+“,“-“与内容之间(4)“-“、“.“前后不加空格。p-id = pid; / “-“指针前后不加空格(5) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显。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 re
6、plicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;2-9：对于 所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方示例：/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* act
7、ive statistic task number */2-10： 数据结构声明( 包括数组、结构、类、枚举等) ，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方示例：可按如下形式说明枚举/数据/ 联合结构。/* sccp interface with sccp user primitive message name */enum SCCP_USER_PRIMITIVEN_UNITDATA_IND, /* sccp notify sccp user unit data come */N_NOTICE_IND,
8、/* sccp notify user the No.7 network can not */* transmission this message */N_UNITDATA_REQ, /* sccp users unit data transmission request*/;2-11：全局变量要有较详细的注释，包括对其功能、取值范围、 哪些函数或过程存取它以及存取时注意事项等的说明示例：/* The ErrorCode when SCCP translate */* Global Title failure, as follows */ / 变量作用、含义/* 0 SUCCESS 1 GT
9、 Table error */* 2 GT error Others no use */ / 变量取值范围/* only function SCCPTranslate() in */* this modual can modify it, and other */* module can visit it through call */* the function GetGTTransErrorCode() */ / 使用方法BYTE g_GTTranErrorCode; 2-12：注释与所描述内容进行同样的缩排说明：可使程序排版整齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍
10、感不方便。void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two应改为如下布局。void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two2-13：将注释与其上面的代码用空行隔开示例：如下例子，显得代码过于紧凑。/* code one comments */program code one/* code two comment
11、s */program code two应如下书写/* code one comments */program code one/* code two comments */program code two2-14：对 变量的定义和分支语句（条件分支、循环语句等）必须编写注释说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。2-15：对于 switch 语句下的 case 语句，如果因为特殊情况需要处理完一个 case 后进入下一个case 处理，必须在该 case 语句处理完、下一个 case 语句前加上明确的注释说明：这
12、样比较清楚程序编写者的意图，有效防止无故遗漏 break 语句。示例（注意斜体加粗部分）：case CMD_UP: ProcessUp(); break;case CMD_DOWN: ProcessDown(); break;case CMD_FWD: ProcessFwd(); if (.).break;elseProcessCFW_B(); / now jump into case CMD_Acase CMD_A: ProcessA(); break;case CMD_B: ProcessB(); break;case CMD_C: ProcessC(); break;case CMD_D
13、: ProcessD(); break;.2-1：避免在一行代码或表达式的中间插入注释说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/* if receive_flag is TRUE */if (rec
14、eive_flag)而如下的注释则给出了额外有用的信息。/* if mtp receive a message from links */if (receive_flag)2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。if (.)/ program codewhile (index MAX_INDEX)/ program code /* end of while (index MAX_INDEX) */ / 指明该条 while 语句结束 /* end of if (.)*/ / 指明是
15、哪条 if 语句结束2-5：注释格式尽量统一，建议使用“/* */”2-6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。三 = 标识符命名 = 3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。示例：如下单词的缩写能够被大家基本认可。temp 可缩写为 tmp ;flag 可缩写为
16、flg ;statistic 可缩写为 stat ;increment 可缩写为 inc ;message 可缩写为 msg ;3-2：命名中若使用特殊约定或缩写，则要有注释说明说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。3-3：自己特有的命名风格，要自始至终保持一致，不可来回变化说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即命名规则中没有规定到的地方才可有个人命名风格）。3-4：对于 变量命名，禁止取单个字符（如 i、j、k. ），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但 i、j、k 作局
17、部循环变量是允许的说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如 i 写成 j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。示例：下面所示的局部变量名的定义方法可以借鉴。int liv_Width其变量名解释如下：l 局部变量（Local） （其它： g 全局变量（Global ）.）i 数据类型（Interger）v 变量（Variable） （其它：c 常量（Const）.）Width 变量含义这样可以防止局部变量与全局变量重名。3-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用 UNIX 的全小写加下划线的风格或大小写混
18、排的方式，不要使用大小写与下划线混排的方式，用作特殊标识如标识成员变量或全局变量的 m_和 g_，其后加上大小写混排的方式是允许的示例： Add_User 不允许，add_user、AddUser、m_AddUser 允许。3-1：除非必要，不要用数字或较奇怪的字符来定义标识符示例：如下命名，使人产生疑惑。#define _EXAMPLE_0_TEST_#define _EXAMPLE_1_TEST_void set_sls00( BYTE sls );应改为有意义的单词命名#define _EXAMPLE_UNIT_TEST_#define _EXAMPLE_ASSERT_TEST_void
19、 set_udt_msg_sls( BYTE sls );3-2：在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防止编译、链接时产生冲突说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上“模块” 标识等。3-3：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等说明：下面是一些在软件中常用的反义词组。add / remove begin / end create / destroy insert / delete first / last g et / releaseincrement / decrement put /
20、getadd / delete lock / unlock open / closemin / max old / new start / stopnext / previous source / target show / hidesend / receive source / destinationcut / paste up / down示例：int min_sum;int max_sum;int add_user( BYTE *user_name );int delete_user( BYTE *user_name );3-4：除了编译开关/头文件等特殊应用，应避免使用_EXAMPLE
21、_TEST_ 之类以下划线开始和结尾的定义四 = 可读性 = 4-1：注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级说明：防止阅读程序时产生误解，防止因默认的优先级与设计思想不符而导致程序出错。示例：下列语句中的表达式word = (high 8) | low (1)if (a | b) & (a & c) (2)if (a | b) (c & d) (3)如果书写为:high 8 | lowa | b & a & ca | b c & d由于high 8 | low = ( high 8) | low,a | b & a & c = (a | b) & (a & c)，(1)(2)不会出错，但语句不易理解；a | b c & d = a | （b c） & d，(3)造成了判断条件出错。4-2：避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替
