华为软件编程规范和范例讲课讲稿.doc

Good is good, but better carries it.精益求精，善益求善。华为软件编程规范和范例-目 录1排版62注释113标识符命名184可读性205变量、结构226函数、过程287可测性368程序效率409质量保证4410代码编辑、编译、审查5011代码测试、维护5212宏531排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。¹1-2：相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if(!valid_ni(ni)   ./programcoderepssn_ind=ssn_dataindex.repssn_index;repssn_ni =ssn_dataindex.ni; 应如下书写if(!valid_ni(ni)   ./programcoderepssn_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_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<MAX_ACT_TASK_NUMBER)                     &&(n7stat_stat_item_valid(stat_item)                     &&(act_task_tabletaskno.result_data!=0);¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。示例：if(taskno<max_act_task_number)   &&(n7stat_stat_item_valid(stat_item)   ./programcodefor(i=0,j=0;(i<BufferKeywordword_index.word_length)                   &&(j<NewKeyword.word_length);i+,j+)   ./programcodefor(i=0,j=0;     (i<first_word_length)&&(j<second_word_length);     i+,j+)   ./programcode¹1-5：若函数或过程中的参数较长，则要进行适当的划分。示例：n7stat_str_compare(BYTE*)&stat_object,                  (BYTE*)&(act_task_tabletaskno.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等语句的执行语句部分无论多少都要加括号。示例：如下例子不符合规范。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(.)   ./programcodeif(.)      ./programcode   voidexample_fun(void)      ./programcode   应如下书写。for(.)   ./programcodeif(.)   ./programcodevoidexample_fun(void)   ./programcode¹1-11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如>），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。 示例：(1)逗号、分号只在后面加空格。inta,b,c;  (2)比较操作符,赋值操作符"="、"+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、""等双目操作符的前后加空格。if(current_time>=MAX_TIME_VALUE)a=b+c;a*=2;a=b2; (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-1：一般情况下，源程序有效注释量必须在20以上。说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。¹2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/* Copyright(C),1988-1999,HuaweiTech.Co.,Ltd. Filename:     /文件名 Author:      Version:       Date:/作者、版本及完成日期 Description:   /用于详细说明此程序文件完成的主要功能，与其他模块                 /或函数的接口，输出值、取值范围、含义及参数间的控                 /制、顺序、独立或依赖等关系 Others:        /其它内容的说明 FunctionList: /主要函数列表，每条记录应包括函数名及功能简要说明   1. History:       /修改历史记录列表，每条修改记录应包括修改日期、修改                 /者及修改内容简述    1.Date:      Author:      Modification:   2.*/¹2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/* Copyright(C),1988-1999,HuaweiTech.Co.,Ltd. FileName:test.cpp Author:       Version:         Date: Description:    /模块描述      Version:        /版本信息 FunctionList:  /主要函数及其功能   1.- History:        /历史修改记录     <author> <time>  <version>  <desc>     David   96/10/12    1.0    buildthismoudle */说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。¹2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/* Function:      /函数名称 Description:   /函数功能、性能等的描述 Calls:         /被本函数调用的函数清单 CalledBy:     /调用本函数的函数清单 TableAccessed:/被访问的表（此项仅对于牵扯到数据库操作的程序） TableUpdated: /被修改的表（此项仅对于牵扯到数据库操作的程序） Input:         /输入参数说明，包括每个参数的作                 /用、取值说明及参数间关系。 Output:        /对输出参数的说明。 Return:        /函数返回值的说明 Others:        /其它说明*/¹2-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。¹2-6：注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。规则2-7：避免在注释中使用缩写，特别是非常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。¹2-8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。示例：如下例子不符合规范。例1：/*getreplicatesubsystemindexandnetindicator*/ repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni; 例2：repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;/*getreplicatesubsystemindexandnetindicator*/ 应如下书写/*getreplicatesubsystemindexandnetindicator*/repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;¹2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例：/*activestatistictasknumber*/#defineMAX_ACT_TASK_NUMBER1000#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/¹2-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。示例：可按如下形式说明枚举/数据/联合结构。/*sccpinterfacewithsccpuserprimitivemessagename*/enum SCCP_USER_PRIMITIVE   N_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/   N_NOTICE_IND,  /*sccpnotifyusertheNo.7networkcannot*/                   /*transmissionthismessage*/   N_UNITDATA_REQ,/*sccpuser'sunitdatatransmissionrequest*/;¹2-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。示例：/*TheErrorCodewhenSCCPtranslate*/*GlobalTitlefailure,asfollows*/     /变量作用、含义/*0SUCCESS  1GTTableerror*/*2GTerror Othersnouse */      /变量取值范围/*only function SCCPTranslate()in*/*thismodualcanmodifyit, and other*/*modulecanvisititthroughcall*/*the functionGetGTTransErrorCode()*/   /使用方法BYTEg_GTTranErrorCode; ¹2-12：注释与所描述内容进行同样的缩排。说明：可使程序排版整齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍感不方便。voidexample_fun(void)/*codeonecomments*/   CodeBlockOne       /*codetwocomments*/   CodeBlockTwo应改为如下布局。voidexample_fun(void)   /*codeonecomments*/   CodeBlockOne   /*codetwocomments*/   CodeBlockTwo¹2-13：将注释与其上面的代码用空行隔开。示例：如下例子，显得代码过于紧凑。/*codeonecomments*/programcodeone/*codetwocomments*/programcodetwo应如下书写/*codeonecomments*/programcodeone/*codetwocomments*/programcodetwo¹2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。¹2-15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。示例（注意斜体加粗部分）：caseCMD_UP:     ProcessUp();   break;caseCMD_DOWN:   ProcessDown();   break;caseCMD_FWD:    ProcessFwd();if(.)   .   break;else   ProcessCFW_B();  /nowjumpintocaseCMD_AcaseCMD_A:      ProcessA();      break;caseCMD_B:      ProcessB();      break;caseCMD_C:      ProcessC();      break;caseCMD_D:      ProcessD();      break;.½2-1：避免在一行代码或表达式的中间插入注释。说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。½2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。½2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/*ifreceive_flagisTRUE*/if(receive_flag)而如下的注释则给出了额外有用的信息。/*ifmtpreceiveamessagefromlinks*/if(receive_flag)½2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束。说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。if(.)   /programcode   while(index<MAX_INDEX)          /programcode   /*endofwhile(index<MAX_INDEX)*/指明该条while语句结束/*endof if(.)*/指明是哪条if语句结束½2-5：注释格式尽量统一，建议使用“/*/”。½2-6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。3标识符命名¹3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。示例：如下单词的缩写能够被大家基本认可。temp可缩写为 tmp flag可缩写为 flg statistic可缩写为 stat;increment可缩写为 inc message可缩写为 msg ¹3-2：命名中若使用特殊约定或缩写，则要有注释说明。说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。¹3-3：自己特有的命名风格，要自始至终保持一致，不可来回变化。说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即命名规则中没有规定到的地方才可有个人命名风格）。¹3-4：对于变量命名，禁止取单个字符（如i、j、k.），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。示例：下面所示的局部变量名的定义方法可以借鉴。intliv_Width其变量名解释如下：      l     局部变量（Local） （其它：g   全局变量（Global）.）      i     数据类型（Interger）      v     变量（Variable）  （其它：c   常量（Const）.）      Width 变量含义这样可以防止局部变量与全局变量重名。¹3-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用作特殊标识如标识成员变量或全局变量的m_和g_，其后加上大小写混排的方式是允许的。示例：Add_User不允许，add_user、AddUser、m_AddUser允许。½3-1：除非必要，不要用数字或较奇怪的字符来定义标识符。示例：如下命名，使人产生疑惑。#define_EXAMPLE_0_TEST_#define_EXAMPLE_1_TEST_voidset_sls00(BYTEsls);应改为有意义的单词命名#define_EXAMPLE_UNIT_TEST_#define_EXAMPLE_ASSERT_TEST_voidset_udt_msg_sls(BYTEsls);½3-2：在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防止编译、链接时产生冲突。说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。½3-3：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。说明：下面是一些在软件中常用的反义词组。add/remove      begin/end       create/destroyinsert/delete   first/last      get/releaseincrement/decrement                put/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_TEST_之类以下划线开始和结尾的定义。4可读性¹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：避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。示例：如下的程序可读性差。if(Trunkindex.trunk_state=0)   Trunkindex.trunk_state=1;   . /programcode应改为如下形式。#defineTRUNK_IDLE0#defineTRUNK_BUSY1if(Trunkindex.trunk_state=TRUNK_IDLE)   Trunkindex.trunk_state=TRUNK_BUSY;   . /programcode½4-1：源程序中关系较为紧密的代码应尽可能相邻。说明：便于程序阅读和查找。示例：以下代码布局不太合理。rect.length=10;char_poi=str;rect.width=5;若按如下形式书写，可能更清晰一些。rect.length=10;rect.width=5;/矩形的长与宽关系较密切，放在一起。char_poi=str;½4-2：不要使用难懂的技巧性很高的语句，除非很有必要时。说明：高技巧语句不等于高效率的程序，实际上程序的效率关键在于算法。示例：如下表达式，考虑不周就可能出问题，也较难理解。*stat_poi+=1;*+stat_poi+=1;应分别改为如下。*stat_poi+=1;stat_poi+;    /此二语句功能相当于“*stat_poi+=1;”+stat_poi;*stat_poi+=1;/此二语句功能相当于“*+stat_poi+=1;”5变量、结构¹5-1：去掉没必要的公共变量。说明：公共变量是增大模块间耦合的原因之一，故应减少没必要的公共变量以降低模块间的耦合度。¹5-2：仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。说明：在对变量声明的同时，应对其含义、作用及取值范围进行注释说明，同时若有必要还应说明与其它变量的关系。¹5-3：明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。说明：明确过程操作变量的关系后，将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。示例：在源文件中，可按如下注释形式说明。RELATION   System_Init   Input_Rec   Print_Rec  Stat_ScoreStudent    Create        Modify      Access     AccessScore      Create        Modify      Access     Access,Modify注：RELATION为操作关系；System_Init、Input_Rec、Print_Rec、Stat_Score为四个不同的函数；Student、Score为两个全局变量；Create表示创建，Modify表示修改，Access表示访问。其中，函数Input_Rec、Stat_Score都可修改变量Score，故此变量将引起函数间较大的耦合，并可能增加代码测试、维护的难度。¹5-4：当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。说明：对公共变量赋值时，若有必要应进行合法性检查，以提高代码的可靠性、稳定性。¹5-5：防止局部变量与公共变量同名。说明：若使用了较好的命名规则，那么此问题可自动消除。¹5-6：严禁使用未经初始化的变量作为右值。说明：特别是在C/C+中引用未经赋值的指针，经常会引起系统崩溃。½5-1：构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共变量，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。说明：降低公共变量耦合度。½5-2：使用严格形式定义的、可移植的数据类型，尽量不要使用与具体硬件或软件环境关系密切的变量。说明：使用标准的数据类型，有利于程序的移植。示例：如下例子（在DOS下BC3.1环境中），在移植时可能产生问题。voidmain()   registerintindex;/寄存器变量   _AX=0x4000;/_AX是BC3.1提供的寄存器“伪变量”   ./programcode½5-3：结构的功能要单一，是针对一种事务的抽象。说明：设计结构时应力争使结构代表一种现实事务的抽象，而不是同时代表多种。结构中的各元素应代表同一事务的不同侧面，而不应把描述没有关系或关系很弱的不同事务的元素放到同一结构中。示例：如下结构不太清晰、合理。typedefstructSTUDENT_STRU   unsignedcharname8;/*student'sname*/   unsignedcharage;    /*student'sage*/   unsignedcharsex;    /*student'ssex,asfollows*/                          /*0-FEMALE;1-MALE*/   unsignedchar          teacher_name8;/*thestudentteacher'sname*/   unisgnedchar          teacher_sex;    /*histeachersex*/STUDENT;若改为如下，可能更合理些。typedefstructTEACHER_STRU   unsignedcharname8;/*teachername*/   unisgnedcharsex;    /*teachersex,asfollows*/                          /*0-FEMALE;1-MALE*/TEACHER;typedefstructSTUDENT_STRU   unsignedcharname8;    /*student'sname*/   unsignedcharage;        /*student'sage*/   unsignedcharsex;        /*student'ssex,asfollows*/                              /*0-FEMALE;1-MALE*/   unsignedint teacher_ind;/*histeacherindex*/STUDENT;½5-4：不要设计面面俱到、非常灵活的数据结构。说明：面面俱到、灵活的数据结构反而容易引起误解和操作困难。½5-5：不同结构间的关系不要过于复杂。说明：若两个结构间关系较复杂、密切，那么应合为一个结构。示例：如下两个结构的构造不合理。typedefstructPERSON_ONE_STRU   unsignedcharname8;   unsignedcharaddr40;   unsignedcharsex;   unsignedcharcity15;PERSON_ONE;typedefstructPERSON_TWO_STRU   unsignedcharname8;   unsignedcharage;   unsignedchartel;PERSON_TWO;由于两个结构都是描述同一事物的，那么不如合成一个结构。typedefstructPERSON_STRU   unsignedcharname8;   unsignedcharage;   unsignedcharsex;   unsignedcharaddr40;   unsignedcharcity15;   unsignedchartel;PERSON;½5-6：结构中元素的个数应适中。若结构中元素个数过多可考虑依据某种原则把元素组成不同的子结构，以减少原结构中元素的个数。说明：增加结构的可理解性、可操作性和可维护性。示例：假如认为如上的_PERSON结构元素过多，那么可如下对之划分。