华为软件编程规范和范例讲课讲稿.doc
《华为软件编程规范和范例讲课讲稿.doc》由会员分享,可在线阅读,更多相关《华为软件编程规范和范例讲课讲稿.doc(125页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、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.rep
2、ssn_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);a
3、ct_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=(tasknoMAX_ACT_TASK_NUMBER)&(n7stat_stat_item_valid(stat_item)&(act_task_tabletaskno.result_data!=0);1-4:循环、判断等语句中
4、若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。示例:if(tasknomax_act_task_number)&(n7stat_stat_item_valid(stat_item)./programcodefor(i=0,j=0;(iBufferKeywordword_index.word_length)&(jNewKeyword.word_length);i+,j+)./programcodefor(i=0,j=0;(ifirst_word_length)&(j),后不应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于
5、留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C+语言中括号已经是最清晰的标志了。在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例:(1)逗号、分号只在后面加空格。inta,b,c;(2)比较操作符,赋值操作符=、+=,算术操作符+、%,逻辑操作符&、&,位域操作符=MAX_TIME_VALUE)a=b+c;a*=2;a=b2;(3)!、+、-、&(地址运算符)等单目操作符前后不加空格。*p=
6、a;/内容操作*与内容之间flag=!isEmpty;/非操作!与内容之间p=&mem;/地址操作&与内容之间i+;/+,-与内容之间(4)-、.前后不加空格。p-id=pid;/-指针前后不加空格(5)if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。if(a=b&cd)1-1:一行程序以小于80字符为宜,不要写得过长。2注释2-1:一般情况下,源程序有效注释量必须在20以上。说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。2-2:说明性文件(如头文件.h文件、.inc文件、.de
7、f文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.Filename:/文件名Author:Version:Date:/作者、版本及完成日期Description:/用于详细说明此程序文件完成的主要功能,与其他模块/或函数的接口,输出值、取值范围、含义及参数间的控/制、顺序、独立或依赖等关系Othe
8、rs:/其它内容的说明FunctionList:/主要函数列表,每条记录应包括函数名及功能简要说明1.History:/修改历史记录列表,每条修改记录应包括修改日期、修改/者及修改内容简述1.Date:Author:Modification:2.*/2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*Copyright(C),1988-1999,HuaweiTech.Co.,Ltd.FileName:test.cppAuthor:Versi
9、on:Date:Description:/模块描述Version:/版本信息FunctionList:/主要函数及其功能1.-History:/历史修改记录David96/10/121.0buildthismoudle*/说明:Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*
10、Function:/函数名称Description:/函数功能、性能等的描述Calls:/被本函数调用的函数清单CalledBy:/调用本函数的函数清单TableAccessed:/被访问的表(此项仅对于牵扯到数据库操作的程序)TableUpdated:/被修改的表(此项仅对于牵扯到数据库操作的程序)Input:/输入参数说明,包括每个参数的作/用、取值说明及参数间关系。Output:/对输出参数的说明。Return:/函数返回值的说明Others:/其它说明*/2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。2-6:注释的内容要清楚、明了,
11、含义准确,防止注释二义性。说明:错误的注释不但无益反而有害。规则2-7:避免在注释中使用缩写,特别是非常用缩写。说明:在使用缩写时或之前,应对缩写进行必要的说明。2-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。示例:如下例子不符合规范。例1:/*getreplicatesubsystemindexandnetindicator*/repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;例2:repssn_ind=ssn_d
12、ataindex.repssn_index;repssn_ni=ssn_dataindex.ni;/*getreplicatesubsystemindexandnetindicator*/应如下书写/*getreplicatesubsystemindexandnetindicator*/repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例:/*activest
13、atistictasknumber*/#defineMAX_ACT_TASK_NUMBER1000#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/2-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。示例:可按如下形式说明枚举/数据/联合结构。/*sccpinterfacewithsccpuserprimitivemessagename*/enumSCCP_USER_PRIMITIVEN_UNI
14、TDATA_IND,/*sccpnotifysccpuserunitdatacome*/N_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannot*/*transmissionthismessage*/N_UNITDATA_REQ,/*sccpusersunitdatatransmissionrequest*/;2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。示例:/*TheErrorCodewhenSCCPtranslate*/*GlobalTitlefailure,asfollows*/变量
15、作用、含义/*0SUCCESS1GTTableerror*/*2GTerrorOthersnouse*/变量取值范围/*onlyfunctionSCCPTranslate()in*/*thismodualcanmodifyit,andother*/*modulecanvisititthroughcall*/*thefunctionGetGTTransErrorCode()*/使用方法BYTEg_GTTranErrorCode;2-12:注释与所描述内容进行同样的缩排。说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。voidexample_fun(vo
16、id)/*codeonecomments*/CodeBlockOne/*codetwocomments*/CodeBlockTwo应改为如下布局。voidexample_fun(void)/*codeonecomments*/CodeBlockOne/*codetwocomments*/CodeBlockTwo2-13:将注释与其上面的代码用空行隔开。示例:如下例子,显得代码过于紧凑。/*codeonecomments*/programcodeone/*codetwocomments*/programcodetwo应如下书写/*codeonecomments*/programcodeone/*
17、codetwocomments*/programcodetwo2-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。2-15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。示例(注意斜体加粗部分):caseCMD_UP:ProcessUp();break;caseCMD_DO
18、WN:ProcessDown();break;caseCMD_FWD:ProcessFwd();if(.).break;elseProcessCFW_B();/nowjumpintocaseCMD_AcaseCMD_A:ProcessA();break;caseCMD_B:ProcessB();break;caseCMD_C:ProcessC();break;caseCMD_D:ProcessD();break;.2-1:避免在一行代码或表达式的中间插入注释。说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。2-2:通过对函数或过程、变量、结构等正确的命名以及合理地组织
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 华为 软件 编程 规范 范例 讲课 讲稿
限制150内