华为的编程规范和范例.pdf
《华为的编程规范和范例.pdf》由会员分享,可在线阅读,更多相关《华为的编程规范和范例.pdf(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-1 :程序块要采用缩进风格编写,缩进的空格数为4个。 说明:对于由开发工具自动生成的代码可以有不一致。 1 1-2 :相对独立的程序块之间、变量说明之后必须加空行。 示例:如下例子不符合规范。 if (!valid_ni(ni) . / program code repssn_ind = ssn_datai
2、ndex.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 1-3 :较长的语句(80 字符)要分成多行书写,长表达式要在低优先级操作符处划分新行, 操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。 示例: perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LE
3、N + 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 = SYS_get_sccp_statistic_state( stat_item ); report_or_not_flag = (taskno ),后不应加空 格。 说明:采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性
4、是相对的,所以,在已经非常清晰的语句中没有必要再留空格, 如果语句已足够清晰则括号内侧( 即左括号后面和右括号前面) 不需要加空格, 多重括号间 不必加空格,因为在C/C+ 语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给 操作符留空格时不要连续留两个以上空格。 示例: (1) 逗号、分号只在后面加空格。 int a, b, c; 软件编程规范总则1 排版 仅供内部使用7 (2) 比较操作符 , 赋值操作符 “=“ 、 “+=“,算术操作符 “+“ 、“%“ ,逻辑操作符“ a *= 2; a = b 2; (3)“!“、 “ 、
5、“+“ 、 “-“、“ / 内容操作 “*“与内容之间 flag = !isEmpty; / 非操作 “!“与内容之间 p = / 地址操作 “ / “+“,“-“与内容之间 (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;
6、 /* 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_dataindex.ni; 1 2-9 :对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加 以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。 示例: /* active statistic task
7、number */ #define MAX_ACT_TASK_NUMBER 1000 软件编程规范总则2 注释 仅供内部使用11 #define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */ 1 2-10 :数据结构声明( 包括数组、结构、类、枚举等) ,如果其命名不是充分自注释的,必须 加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注 释放在此域的右方。 示例:可按如下形式说明枚举/ 数据 / 联合结构。 /* sccp interface with sccp user primiti
8、ve message name */ enum SCCP_USER_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*/ ; 1 2-11 :全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或
9、过程存取它以及 存取时注意事项等的说明。 示例: /* 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 visit it through
10、call */ /* the function GetGTTransErrorCode() */ / 使用方法 BYTE g_GTTranErrorCode; 1 2-12 :注释与所描述内容进行同样的缩排。 说明:可使程序排版整齐,并方便注释的阅读与理解。 示例:如下例子,排版不整齐,阅读稍感不方便。 void example_fun( void ) /* code one comments */ CodeBlock One 软件编程规范总则2 注释 仅供内部使用12 /* code two comments */ CodeBlock Two 应改为如下布局。 void example_fu
11、n( void ) /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two 1 2-13 :将注释与其上面的代码用空行隔开。 示例:如下例子,显得代码过于紧凑。 /* code one comments */ program code one /* code two comments */ program code two 应如下书写 /* code one comments */ program code one /* code two comments */ program code two 1
12、 2-14 :对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。 说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮 助更好的理解程序,有时甚至优于看设计文档。 1 2-15 :对于 switch语句下的 case 语句,如果因为特殊情况需要处理完一个case 后进入下一 个 case 处理,必须在该case 语句处理完、下一个case 语句前加上明确的注释。 说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。 软件编程规范总则2 注释 仅供内部使用13 示例(注意斜体加粗部分): case CMD_UP: ProcessUp(); br
13、eak; 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: ProcessB(); break; case CMD_C: ProcessC(); break; case CMD_D: ProcessD(); 软件编程规范总则2 注释 仅供内部使用14 break; . ? 2-1:避免在一行代码或表达式的
14、中间插入注释。 说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。 ? 2-2:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为 自注释的。 说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。 ? 2-3:在代码的功能、意图层次上进行注释,提供有用、额外的信息。 说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读 者理解代码,防止没必要的重复注释信息。 示例:如下注释意义不大。 /* if receive_flag is TRUE */ if (receive_flag) 而如下的注释则给出
15、了额外有用的信息。 /* if mtp receive a message from links */ if (receive_flag) ? 2-4:在程序块的结束行右方加注释标记,以表明某程序块的结束。 说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。 示例:参见如下例子。 if (.) / program code while (index b ) ? a : b ; 改为如下就很清晰了。 int max (int a, int b) return (a b) ? a : b); value = max (a, b); 或改为如下。 #define MAX (a
16、, b) (a) (b) ? (a) : (b) value = MAX (a, b); 软件编程规范总则6 函数、过程 仅供内部使用31 ? 6-5:不要设计多用途面面俱到的函数。 说明:多功能集于一身的函数,很可能使函数的理解、测试、维护等变得困难。 ? 6-6:函数的功能应该是可以预测的,也就是只要输入数据相同就应产生同样的输出。 说明:带有内部“存储器”的函数的功能可能是不可预测的,因为它的输出可能取决于内 部存储器(如某标记)的状态。这样的函数既不易于理解又不利于测试和维护。在 C/C+ 语言中,函数的static局部变量是函数的内部存储器,有可能使函数的功能不可预测, 然而,当某函
17、数的返回值为指针类型时,则必须是STATIC 的局部变量的地址作为返回值, 若为 AUTO类,则返回为错针。 示例:如下函数,其返回值(即功能)是不可预测的。 unsigned int integer_sum( unsigned int base ) unsigned int index; static unsigned int sum = 0; / 注意,是static类型的。 / 若改为 auto类型,则函数即变为可预测。 for (index = 1; index B-C-A) ,影响程序的可理解性;递 归调用一般都占用较多的系统资源(如栈空间);递归调用对程序的测试有一定影响。故 除非
18、为某些算法或功能的实现方便,应减少没必要的递归调用。 ? 6-25:仔细分析模块的功能及性能需求,并进一步细分,同时若有必要画出有关数据流图, 据此来进行模块的函数划分与组织。 说明:函数的划分与组织是模块的实现过程中很关键的步骤,如何划分出合理的函数结构, 关系到模块的最终效率和可维护性、可测性等。根据模块的功能图或/ 及数据流图映射出 软件编程规范总则6 函数、过程 仅供内部使用36 函数结构是常用方法之一。 ? 6-26:改进模块中函数的结构,降低函数间的耦合度,并提高函数的独立性以及代码可读性、 效率和可维护性。优化函数结构时,要遵守以下原则: (1)不能影响模块功能的实现。 (2)仔
19、细考查模块或函数出错处理及模块的性能要求并进行完善。 (3)通过分解或合并函数来改进软件结构。 (4)考查函数的规模,过大的要进行分解。 (5)降低函数间接口的复杂度。 (6)不同层次的函数调用要有较合理的扇入、扇出。 (7)函数功能应可预测。 (8)提高函数内聚。 (单一功能的函数内聚最高) 说明:对初步划分后的函数结构应进行改进、优化,使之更为合理。 ? 6-27:在多任务操作系统的环境下编程,要注意函数可重入性的构造。 说明:可重入性是指函数可以被多个任务进程调用。在多任务操作系统中,函数是否具有 可重入性是非常重要的,因为这是多个进程可以共用此函数的必要条件。另外,编译器是 否提供可重
20、入函数库,与它所服务的操作系统有关,只有操作系统是多任务时,编译器才 有可能提供可重入函数库。如DOS下 BC 和 MSC等就不具备可重入函数库,因为DOS是 单用户单任务操作系统。 ? 6-28:避免使用BOOL参数。 说明:原因有二,其一是BOOL参数值无意义,TURE/FALSE的含义是非常模糊的,在调 用时很难知道该参数到底传达的是什么意思;其二是 BOOL参数值不利于扩充。 还有 NULL 也是一个无意义的单词。 ? 6-29: 对于提供了返回值的函数,在引用时最好使用其返回值。 ? 6-30:当一个过程(函数)中对较长变量(一般是结构的成员)有较多引用时,可以用一个 意义相当的宏代
21、替。 说明:这样可以增加编程效率和程序的可读性。 示例:在某过程中较多引用TheReceiveBufferFirstSocket.byDataPtr, 则可以通过以下宏定义来代替: # define pSOCKDATA TheReceiveBufferFirstScoket.byDataPtr 软件编程规范总则7 可测性 仅供内部使用37 7 可测性 1 7-1 :在同一项目组或产品组内,要有一套统一的为集成测试与系统联调准备的调测开关及相 应打印函数,并且要有详细的说明。 说明:本规则是针对项目组或产品组的。 1 7-2 :在同一项目组或产品组内,调测打印出的信息串的格式要有统一的形式。信息
22、串中至少 要有所在模块名(或源文件名)及行号。 说明:统一的调测信息格式便于集成测试。 1 7-3 :编程的同时要为单元测试选择恰当的测试点,并仔细构造测试代码、测试用例,同时给 出明确的注释说明。测试代码部分应作为(模块中的)一个子模块,以方便测试代码在模块中 的安装与拆卸(通过调测开关)。 说明:为单元测试而准备。 1 7-4 :在进行集成测试/ 系统联调之前,要构造好测试环境、测试项目及测试用例,同时仔细 分析并优化测试用例,以提高测试效率。 说明:好的测试用例应尽可能模拟出程序所遇到的边界值、各种复杂环境及一些极端情况 等。 1 7-5 :使用断言来发现软件问题,提高代码可测性。 说明
23、:断言是对某种假设条件进行检查(可理解为若条件成立则无动作,否则应报告), 它可以快速发现并定位软件问题,同时对系统错误进行自动报警。断言可以对在系统中隐 藏很深,用其它手段极难发现的问题进行定位,从而缩短软件问题定位时间,提高系统的 可测性。实际应用时,可根据具体情况灵活地设计断言。 示例:下面是C 语言中的一个断言,用宏来设计的。(其中 NULL 为 0L) #ifdef _EXAM_ASSERT_TEST_ / 若使用断言测试 void exam_assert( char * file_name, unsigned int line_no ) printf( “nEXAMAssert f
24、ailed: %s, line %un“, file_name, line_no ); abort( ); 软件编程规范总则7 可测性 仅供内部使用38 #define EXAM_ASSERT( condition ) if (condition) / 若条件成立,则无动作 NULL; else / 否则报告 exam_assert( _FILE_, _LINE_ ) #else / 若不使用断言测试 #define EXAM_ASSERT(condition) NULL #endif /* end of ASSERT */ 1 7-6 :用断言来检查程序正常运行时不应发生但在调测时有可能发生
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 华为 编程 规范 范例
链接地址:https://www.31doc.com/p-5518580.html