C++-编程规范总则.pdf
《C++-编程规范总则.pdf》由会员分享,可在线阅读,更多相关《C++-编程规范总则.pdf(50页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、软件编程规范总则为了提高源程序的质量和可维护性,最终提高公司软件产品生产力,我们必要对公司软件产品的源程序的编写风格作出统一的规范约束。本规范总则是独立具体语言的编程规则的总的原则,针对不同编程语言或应用环境的编程规范在遵守本规范总则的基础上,还必须遵守相应语言和就用环境的编程规范。本规范总则适用于公司所有产品以及对外合作委托开发产品的软件源程序。本规范总则的内容包括:排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量保证、代码编译、单元测试、程序版本与维护等。本规范总则的示例都以C 语言为背景,采用以下的术语描述:规则:编程时强制必须遵守的原则。建议:编程时必须加以考虑的原则。说明
2、:对此规则或建议进行必要的解释。示例:对此规则或建议从正、反两个方面给出例子。1 排版规则1-1:程序块要采用缩进风格编写,缩进的空格数为4 个。说明:对于由开发工具自动生成的代码可以有不一致。规则1-2:相对独立的程序块之间、变量说明之后必须加空行。示例:如下例子不符合规范if(!valid_ ni(ni)(./program code)repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;应如下书写if(!valid_ ni(ni)./program coderepssn_ind=ssn_dataindex.rep
3、ssn_index;repssn_ni=ssn_dataindex.ni;规 则1-3:较长的语句0 8 0字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。示例:perm_count_msg.head.len=N07_T0_STAT_C0UNT_LEN+STAT_SIZE_FRAM*sizeof(_UL);act_task_tableframeJd*STAT_TASK_CHECK_NUMBER+index.occupied=stat_poiindex.occupied;act_task_tabletaskno.
4、duration_true_or_false=SYS_get_sccp_statistic_state(stat_item);report_or_not_flag=(tasknoMAX_ACT_TASK_NUMBER)&(n7statjtem_valid(stat_item)&(act_task_tabletaskno.result_data!=0);规 则1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。示例:if(tasknomax_act_task_number)&(n7stat_stat_item_valid
5、(statjtem)for(l=0,j=0;(lBufterKeywordword_index.word_length)&(jNewKeyword.word_length);l+,j+)(./program codefor(l=0,j=0;(kfirst_word_length)&(j),后不应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已非常清晰的语句中没有必要再留空格,如括号内侧(左括号后面和右括号前面)不要加空格,多重括号间不必加空格,因为在C/C+语言中括号已经是最清晰的标志了。在长语句中,如果需要加的空格非常多,那么应该保持
6、整体清晰,而在局部不加空格。给操作符留空格时不耍连续留两个以上空格。示例:(1)逗号、分号只在后面加空格int a,b,c;(2)比较操作符,赋值操作符“=、+=”,算术操作符 +”、“”逻辑操作符“&”、“&”,位操作符“=MAX_TIME_VALUE)a=b+c;a*=2;a=bA2;(3)“!”、“+”、“&”(地址运算符)等单目操作前后不加空格*p=a;/内 容 操 作 与 内 容之间flag=!isEmpty;/非操作!”与内容之间p=&mem;/地址操作符“&”与内容之间1+;/“+”,“一”与内容之间(4)前后不加空格p-id=pid;/指针前后不加空格if、fo r、while
7、、sw itch等与后面的括号间应加空格,使i f等关键字更为突出、明显。if(a=b&cd)建 议1-L 一行程序以小于80字符为宜,不要写得过长。建 议1-2:不同类型的操作符混合使用时,即时实现优先级与实际需要相符,最好也使用括号隔离之,以便代码更加清晰。示例:如本来是正确的代码:if(year%4=0 II year%100!=0&year%400=0)如果加上括号,则更清晰。If(year%4)=0 II(year%100)!=0&(year%400)=0)2、注释规则2-1:一般情况下,源程序有效注释量必须在20%以上。说明:注释的原则是有助于程序的阅读理解,在该加的地方都加了,注
8、释不宜太多也不能太少,注释语言必须准确、易懂、简洁。规则2-2:说明性文件(如头文件.h文件、.in c文件、编译说明文件。c fg等)头部应进行注释,注释必须列出:版权说明、版本、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。*Copyright,1988-1999,Huawei Tech.Co.,LtdFile name力文件名Author:Version:Date:作者、版本及完成日期Description:/用于详细说明此程序文件完成的主要功能,与其
9、他模块或函数的接口,输/出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系Others:其它内容说明Function List:/主要函数列表,每条记录应包括函数名及功能简要说明History:/修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述I.Date:Author:Modification2.TH*/规 则2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示 例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*Copyright ,1988-1999,Huaw
10、ei Tech.Co.,Ltd.FileName:test.cppAuthor:Version:Date:Description:/模块描述Version:/版本信息Function List:/主要函数及其功能1.-HistoryJ/历史修改记录 David 96/10/12 1.0 build this moudle*说明:Description 一项描述本文件的内容、功 能、内部各部分之间的关系及本文件与其它文件等。History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。规 则 2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调
11、用关系(函数、表)等。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议包含在内。/*Function:/函数名称Description:/函数功能、性能等的描述Calls:/数调用的函数清单Callsed By:/调用本函数的函数清单Table Accessed:/被访问的表(此项仅对于牵扯到数据库操作的程序)Table Updated:/被修改的表(此项仅对于牵扯到数据库操作的程序)Input:/输入参数说明,包括每个参数的作用、取值说明及参数间关系Output/对输出参数的说明。Return:函数返回值的说明Others:其它说明*I规 则 2-5:边写代码边注释,
12、修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。规则2-6:注释的内容要清楚、明了、含义准确,防止注释二义性。说 明:错误的注释不但无益反而有害。规则2-7:避免在注释中使用缩写,特别是非常用缩写。说明:在使用缩写时或之前,应对缩写进行必要说明。规 则 2-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。示 例:如下例子不符合规范。例 1:/*get replicate sub system index and net indicator*/repssn_ind=ssn
13、dataindex.repssn_n6ex;repssn_ni=ssn_dataindex.ni;例 2repssn_ind=ssn_dataindex.repssn_index;/*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规 则 2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的
14、,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释就放在其上方相邻位置或右方。示例:/*active statistic task number*/#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000/*active statistic task number*/规 则 2-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。示例:可按如下形式说明枚举/数据/联合结构。/*scc
15、p interface with seep user primitive message name*/enum SCCP_USER_PRIMITIVE(N_UNITDATA_IND,/*sccp notify seep user unit date come*/N_UNITDATA_IND,/*sccp notify user the N0.7 network can not*/transmission this message*/N_UNITDATA_REQ,/*sccp users unit data transmission request*/;规 则 2-11:全局变量要有较详细的注释
16、,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等说明。示例:/*The Error Code when SCCP translate*/*Global Title fanilure,as follows*/变量作用、含义/*0-SUCCESS 1-GT Table error*/1*2 GT error Others no use*/变量取值范围/*only function SCCP Translate()in*/*this modual can modify it,and other*/*module can visit it through call*/*the fun
17、ction Get GT Trans Error Code。*/使用方法BYTE g_GTTran ErrorCode规则2-12:注释与所描述内容进行同样的缩排说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。Void examplejun(void)(/*code one comments*/Code Block One/*code two comments8*/Code Block Two应改为如下布局。void examplejun(void)(/*code one comments*/Code block One/*code two comm
18、ents*/Code Block Two)规则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规则2-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时
19、甚至优于看设计文档。规 则 2-15:对 于 switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。示例(注意斜体加粗部分):case CMD_UP:ProcessUpO;break;case CMD_DWON:ProcessDown();break;case CMD_FWDProcessFwd();break;if()break;)else(ProcessCFW_B();/now jump into case CMD_
20、A)case CMD_A:processA();break;case CMD_B:processB();break;case CMD_C:processCQ;break;case CMD_D:processD();break;建议2 7:避免在一行代码或表达式的中间插入注释。说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。建 议2-2:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。建议2 3在代码的功能、意图层次上进行注释,提供有用、额外的信息。说明:注释
21、的目的是解释代码的目的、功能和采用方法,提供代码以外的信息、,帮助读者理解代码,防止没必要的重复注释信息。示例:如下注释意义不大。/*if receivejlag is TRUE*/if(receivejlag)而如下的注释则给出了额外的有用的信息。/*if mtp receive a message from links*/if(receivejlag)建议2-4:在程序块的结束行右方加注释标记,以表明某程序的结束。说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。示例:参见如下例子。(II program codewhile(indexMAXINDEX)指明该条 w
22、hile 语句结束(II program code/*end of if(.)*/指明是哪条i f语句结束建议2-5:注 释 格 式 尽 量 统 一,建 议 使 用.*/建 议2-6:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。3、标 识 符命名规 则 3-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。说明:较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一
23、些单词有大家公认的缩写。示例:如下单词的缩写能够被大家基本认可。temp可缩写为tmp;flag可缩写为fig;Statistic 可缩写为 stat;Increment 可缩写 inc;Message 可缩写 msg;规则3-2:命名中若使用特殊约定或缩写,则要有注释说明。说明:应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进行必要的注释说明。规则3-3:自己特有的命名风格,要自始至终保持一致,不可来回变化。说明:个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。(即命名规则中没有规定到的地方才可有个人命名风格)。规 则3-4:对于变量命名,禁止类
24、型等,(如I、j、k.)建议除了要有具体含义外,还能表明其变量类型、数据类型等,但I、j、k作局部循环变量是允许的。说明:变量,尤其是局部变量,如果用单个字符表示,很 容 易 敲 错(如写成j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。示例:下面所示的局部变量名义方法可以借鉴。Int liv_width其变量名解释如下:I 局部变量(Local)(其它:g全 局 变 更(Global).)i 数据类型(Interger)v 变 量(Variable)(其它:c 常 量(Const).)这样可以防止局部变量与全局变量重名规则3-5:命名规范必须与所使用的系统风格保持一
25、致,并在同一项目中统一,比如采用UNIX的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式。示例:如 Add_User 就不如 add_user 或 AddUser 好。建 议3-1:除非必要,不要用数字或较奇怪的字符来定义标识符。示例:如下命名,使人产生疑惑。#define EXAMPLE 0 TEST#define_EXAMPLE_1_TEST_void set_slsOO(BYTE sis);应改为有意义的单词命名#define_EXAMPLE_UNIT_TEST_#define_EXAMPLE_ASSERT_TEST_void set_udt_msg_sls(B
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 编程 规范 总则
限制150内