C(C)编程规范课程教材注释版.pdf
《C(C)编程规范课程教材注释版.pdf》由会员分享,可在线阅读,更多相关《C(C)编程规范课程教材注释版.pdf(63页珍藏版)》请在得力文库 - 分享文档赚钱的网站上搜索。
1、内部资料,注意保密编程规范教材录前言软件编程规范总则.3第 一 章 排 版.4第 二章注释.10第三章标识符命名.17第四章可读性.20第五章变量、结构.23第六章函数、过程.30第七章可测性.40第八章程序效率.45第九章质量保证.50第十章代码编辑、编译、审查.57第十一章代码测试、维护.59第 十二章宏.61前言软件编程规范总则为了提高源程序的质量和可维护性,最终提高公司软件产品生产力,我们有必要对公司软件产品的源程序的编写风格作出统一的规范约束。本规范总则是独立于具体语言的编程规则的总的原则,针对不同编程语言或应用环境的编程规范在遵守本规范总则的基础上,还必须遵守相应语言和就用环境的编
2、程规范。本规范总则适用于公司所有产品以及对外合作委托开发产品的软件源程序。本规范总则的内容包括:排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量保证、代码编译、单元测试、程序版本与维护等。本规范总则的示例都以C语言为背景,采用以下的术语描述:规则:编程时强制必须遵守的原则。建议:编程时必须加以考虑的原则。说明:对此规则或建议进行必要的解释。示例:对此规则或建议从正、反两个方面给出例子。第一章排版1-1:程序块要采用缩进风格编写,缩进的空格数为4个。说明:对于由开发工具自动生成的代码可以有不一致。唯一例外的是编译开关和宏定义。如下各举一个例子:编译开关例子:int SendMsg(E
3、XEC_MSG*pMsg)(#ifdef _UNIT_DEBUGDoTe/函数其它代码)l-2:相对独立的程序块之间、变量说明之后必须加空行。示例:如下例子不符合规范。if(!valid_ni(ni)(/program code)re;re;应如下书写if(!valid_ni(ni)(/program code)re;re;空行可以使程序结构比较清晰。逻辑上关系比较紧密的代码放在一起,逻辑上相对比较独立的部分用空行隔开。1-3:较长的语句(80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。示例:perm_co
4、unt_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_s
5、tat_item_valid(stat_item)&(act_task_tabletaskno.result_data!=0);长语句分多行书写比较美观。在低优先级操作符处划分新行,可使每一行具有相当独立而完整的含义,从而比较清晰。折行时,操作符要放行首。1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。示例:if(taskno max_act_task_number)&(n7stat_stat_item_valid(stat_item)(/program codefor(i=0,j =0;(i BufferKeyw
6、ordword_index.word_length)&(j NewKeyword.word_length);i+,j+)(./program codefor(i=0,j =0;(i first_word_length)&(j iMsgType)(case EXEC_MSG:OnExecMsg(pMsg);break;/其它case处理语句如果case语句中需要定义新的变量,则必须用 括起来,缩进为:switch(pMsg-iMsgType)(case EXEC_MSG:DWORD dwDataLen=pMsg-dwMemLen-sizeof(MSG_HEAD);OnExecMsg(pMsg,d
7、wDataLen);break;)case SHAKE_HAND_MSG:1-10:程序块的分界符(如C/C+语言的大括号 和 )应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for.do、while,switch,case语句中的程序都要采用如上的缩进方式。示例:如下例子不符合规范。for(.)/program codeif(.)(./program code)void example_fun(void)(./program code应如下书写。for(.)./program codeif()./program code)v
8、oid example_fun(void),./program code1 1-1 1:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如一),后不应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句己足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C+语言中括号已经是最清晰的标志了。在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作
9、符留空格时不要连续留两个以上空格。示例:(1)逗号、分号只在后面加空格。int a,b,c;(2)比较操作符,赋值操作符=、算术操作符 +、3,逻辑操作符位域操作符 =MAX_TIME_VALUE)a=b+c;a*=2;a=b 人 2;(3)!、一 、(地址运算符)等单目操作符前后不加空格。*P=a;/内 容 操 作 与 内 容 之 间flag=lisEmpty;/非操作!与内容之间p=&mem;/地 址 操 作 与 内 容 之 间i+;/+与内容之间(4)前后不加空格。p-id=pid;/指针前后不加空格(5)if、for,while、switch等与后面的括号间应加空格,使if等关键字更为
10、突出、明显。if(a=b&c d)1-1:一行程序以小于80字符为宜,不要写得过长。第二章注释2-1:一般情况下,源程序有效注释量必须在20%以上。说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。20%的标准要求不高,因为文件头部的注释,函数头部的注释就占了很大的比例。因此达到20%注释量,对实际语句的注释量要求不高。2-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还
11、应有函数功能简要说明。示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*Copyright(C),19881999,Huawei Tech.Co.,Ltd.File name:/文件名Author:Version:Date:/作者、版本及完成日期Description:/用于详细说明此程序文件完成的主要功能,与其他模块/或函数的接口,输出值、取值范围、含义及参数间的控/制、顺序、独立或依赖等关系Others:/其它内容的说明Function LiHistory:/修改历史记录列表,每条修改记录应包括修改日期、修改/者及修改内容简述1.Date:Auth
12、or:Modification:2.,目前各种编辑器都提供宏的功能,通过宏功能可以方便的生成函数头,文件头的格式化注释。2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。*Copyright(C),19881999,Huawei Tech.Co.,Ltd.FileName:test.cppAuthor:Version:Date:Description:/模块描述Version:/版本信息Function Li build this moudl
13、e*:A:*/说明:Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*Function:/函数名称Description:/函数功能、性能等的描述Calls:/被本函数调用的函数清单Called By:/调用本函数的函数清单Table Accessed:/被访问的表(此项仅对于
14、牵扯到数据库操作的程序)Table Updated:/被修改的表(此项仅对于牵扯到数据库操作的程序)Input:/输入参数说明,包括每个参数的作/用、取值说明及参数间关系。Output:/对输出参数的说明。Return:/函数返回值的说明Others:/其它说明*/*2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。/先检查参数,看是否满足可执行Sql实际编程过程中,代码与注释的书写关系有三种:1)先写一行代码,然后马上写注释,也即边写代码边写注释2)先写注释,再写代码3)先把代码全写完了,再补注释。第3)种方式是应该严格避免和禁止的。第一种方
15、式应用比较多,主要用与代码不是特别复杂的情况。第二种方式主要用于代码结构非常复杂的情况,举例如下:short ExecSql(PARAM_LIST*pParamList,char*pUserName,char*pPa;re;例2:re;re;/*get replicate sub system index and net indicator*/应如下书写/*get replicate sub system index and net indicator*/re;re;2-9;对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释
16、应放在其上方相邻位置或右方。示例:/*active statistic task number*/#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000/*active statistic task number*/2-1 0:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。示例:可按如下形式说明枚举/数据/联合结构。/*seep interface with seep user primiti
17、ve message name*/enum SCCP_USER_PRIMITIVE(N_UN工TDATA_工ND,/*seep notify seep user unit data come*/N_NOTICE_INDZ/*seep notify user the No.7 network can not*/*transmission this message*/N_UNITDATA_REQ,/*seep users unit data transmission request*/);对结构,类,枚举,联合必须对每一项进行注释,这一点请参见主机分则。2-1 1:全局变量要有较详细的注释,包括对
18、其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。示例:/*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 call*/*the function G
19、etGTTransErrorCode()*/使用方法BYTE g_GTTranErrorCode;2-1 2:注释与所描述内容进行同样的缩排。说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。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*/CodeBlo
20、ck Two)2-1 3:将注释与其上面的代码用空行隔开。示例:如下例子,显得代码过于紧凑。/*code one comments*/program code one/*code two comments*/program code two应如下书写/*code one comments*/program code one/*code two comments*/program code two2-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。变量的定义,
21、如果不是充分自注释的,必须注释,写明其用途,取值范围等。if,for,while,switch 必须力口注释。2-15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。示例(注意斜体加粗部分):case CMD_UP:ProcessUp();break;case CMD_DOWN:ProcessDown();break;case CMD_FWD:Proce(break;elseProcessCFW_B();/n
22、ow jump in to case CMD_A)case CMD_A:ProcessA();break;case CMD_B:ProcessB();break;case CMD_C:ProcessC();break;case CMD_D:ProcessD();break;2-1:避免在一行代码或表达式的中间插入注释。说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。2-2;通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。2-3:在代码的功能、意图层次上进行注
23、释,提供有用、额外的信息。说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。示例:如下注释意义不大。/*if receive_flag is TRUE*/if(receive_flag)而如下的注释则给出了额外有用的信息。/*if mtp receive a message from links*if(receive_flag)必须在代码的实际逻辑含义的层次上进行注释,这样的注释才是有效的注释。否则就失去了注释的作用。%2-4:在程序块的结束行右方加注释标记,以表明某程序块的结束。说明:当代码段较长,特别是多重嵌套时,这样做可以
24、使代码更清晰,更便于阅读。示例:参见如下例子。if()(/program codewhile(index MAX_INDEX)(/program code /*end of while(index AddUser m_AddUser允许。3-1:除非必要,不要用数字或较奇怪的字符来定义标识符。示例:如下命名,使人产生疑惑。#define _EXAMPLE_O_TEST_#define _EXAMPLE_1_TEST_void set_sls00(BYTE sis);应改为有意义的单词命名#define _EXAMPLE_UNIT_TEST_#define _EXAMPLE_ASSERT_TES
25、T_void set_udt_msg_sls(BYTE sis);3-2:在同一软件产品内,应规划好接口部分标识符(变量、结构、函数及常量)的命名,防 止 编 译、链接时产生冲突。说明:对接口部分的标识符应该有更严格限制,防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。3-3:用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。说明:下面是一些在软件中常用的反义词组。add/removebegin/endcreate/destroyinsert/delete first/lastget/releaseincrement/decrementput/getadd/deletel
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 编程 规范 课程 教材 注释
限制150内