经典C编程规范完整篇PPT学习课件.ppt

上传人:满*** 文档编号:97830094 上传时间:2024-07-08 格式:PPT 页数:112 大小:643KB
返回 下载 相关 举报
经典C编程规范完整篇PPT学习课件.ppt_第1页
第1页 / 共112页
经典C编程规范完整篇PPT学习课件.ppt_第2页
第2页 / 共112页
点击查看更多>>
资源描述

《经典C编程规范完整篇PPT学习课件.ppt》由会员分享,可在线阅读,更多相关《经典C编程规范完整篇PPT学习课件.ppt(112页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。

1、C语言编程规范语言编程规范参考华为软件编程规范主要内容C语言编程规范语言编程规范1 排版排版2 注释注释3 标识符命名标识符命名4 可读性可读性5 变量、结构变量、结构6 函数、过程函数、过程7 可测性可测性8 程序效率程序效率9 质量保证质量保证10 代码编辑、编译、审查代码编辑、编译、审查11 代码测试、维护代码测试、维护12 宏宏C语言编程规范语言编程规范1 1 排版排版C语言编程规范语言编程规范1 排版1-1:程序块要采用缩进风格编写,缩进的空格数为:程序块要采用缩进风格编写,缩进的空格数为4个。个。1-2:相对独立的程序块之间、变量说明之后必须加空行。:相对独立的程序块之间、变量说明

2、之后必须加空行。1-3:较长的语句(:较长的语句(80字符)要字符)要分成多行书写分成多行书写,长表达式要在低优先级操作符,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐排版整齐,语句可读。,语句可读。report_or_not_flag=(taskno MAX_ACT_TASK_NUMBER)&(n7stat_stat_item_valid(stat_item)&(act_task_tabletaskno.result_data!=0);C语言编程规范语言编程规范1 排版1-4

3、:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。示例:if(taskno max_act_task_number)&(n7stat_stat_item_valid(stat_item)./program codefor(i=0,j=0;(i BufferKeywordword_index.word_length)&(j),后不应加空格。),后不应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格.如括号内侧(即左括号后面和右括号前面

4、)不需要加空格,多重括号间不必加空格,因为在C/C+语言中括号已经是最清晰的标志了。在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。C语言编程规范语言编程规范1 排版(1)逗号、分号只在后面加空格。逗号、分号只在后面加空格。int a,b,c;(2)比较操作符比较操作符,赋值操作符赋值操作符=、+=,算术操作符,算术操作符+、%,逻辑操作,逻辑操作符符&、&,位域操作符,位域操作符=MAX_TIME_VALUE)a=b+c;a*=2;a=b 2;C语言编程规范语言编程规范1 排版(3)!、+、-、&(地址运算符)等(地址运算符

5、)等单目操作符单目操作符前后不加空格。前后不加空格。*p=a;/内容操作*与内容之间flag=!isEmpty;/非操作!与内容之间p=&mem;/地址操作&与内容之间i+;/+,-与内容之间(4)-、.前后不加空格。前后不加空格。p-id=pid;/-指针前后不加空格(5)if、for、while、switch等与后面的括号间应加空格,等与后面的括号间应加空格,使使if等关键字更为突出、等关键字更为突出、明显明显。if(a=b&c d)C语言编程规范语言编程规范2 2 注释注释C语言编程规范语言编程规范2 注释注释2-1:一般情况下,源程序有效注释量必须在:一般情况下,源程序有效注释量必须在

6、20以上。以上。C语言编程规范语言编程规范2 注释注释/*Copyright(C),1988-1999,Huawei Tech.Co.,Ltd.File name:/文件名文件名 Author:Version:Date:/作者、版本及完成日期作者、版本及完成日期 Description:/用于详细说明此程序文件完成的主要功能,与其他模块用于详细说明此程序文件完成的主要功能,与其他模块 /或函数的接口,输出值、取值范围、含义及参数间的控或函数的接口,输出值、取值范围、含义及参数间的控 /制、顺序、独立或依赖等关系制、顺序、独立或依赖等关系 Others:/其它内容的说明其它内容的说明 Funct

7、ion List:/主要函数列表,每条记录应包括函数名及功能简要说明主要函数列表,每条记录应包括函数名及功能简要说明 1.History:/修改历史记录列表,每条修改记录应包括修改日期、修改修改历史记录列表,每条修改记录应包括修改日期、修改 /者及修改内容简述者及修改内容简述 1.Date:Author:Modification:2.*/2-2:说说明性文件明性文件(如(如头头文件文件.h文件、文件、.inc文件、文件、.def文件、文件、编译说编译说明文明文件件.cfg等)等)头头部部应应进进行注行注释释,注,注释释必必须须列出:列出:版版权说权说明明、版本号版本号、生成日期生成日期、作者作

8、者、内容内容、功能功能、与其它文件的关系与其它文件的关系、修改日志修改日志等,等,头头文文件的注件的注释释中中还应还应有有函数功能函数功能简简要要说说明明。C语言编程规范语言编程规范2 注释注释2-3:源源文文件件头头部部应应进进行行注注释释,列列出出:版版权权说说明明、版版本本号号、生生成成日日期期、作作者者、模模块目的块目的/功能、主要函数及其功能、修改日志等。功能、主要函数及其功能、修改日志等。示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。C语言编程规范语言编程规范2 注释注释说明:明:Description一一项描述本文件的描述本文件的内容、内

9、容、功能、功能、内部各部分内部各部分之之间的关系的关系及及本文本文件与其它文件关系件与其它文件关系等。等。History是是修修改改历史史记录列表列表,每条修改每条修改记录应包包括修改日期、修改括修改日期、修改者及修改内容者及修改内容简述。述。/*Copyright(C),1988-1999,Huawei Tech.Co.,Ltd.FileName:test.cpp Author:Version:Date:Description:/模块描述 Version:/版本信息 Function List:/主要函数及其功能 1.-History:/历史修改记录 David 96/10/12 1.0 b

10、uild this moudle */C语言编程规范语言编程规范2 注释注释2-4:函函数数头头部部应应进进行行注注释释,列列出出:函函数数的的目目的的/功功能能、输输入入参参数数、输输出出参参数数、返回值、调用关系(函数、表)等。返回值、调用关系(函数、表)等。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*Function:/函数名称函数名称 Description:/函数函数功能、性能功能、性能等的描述等的描述 Calls:/被本函数调用的函数清单被本函数调用的函数

11、清单 Called By:/调用本函数的函数清单调用本函数的函数清单 Table Accessed:/被访问的表(此项仅对于牵扯到数据库操作的程序)被访问的表(此项仅对于牵扯到数据库操作的程序)Table Updated:/被修改的表(此项仅对于牵扯到数据库操作的程序)被修改的表(此项仅对于牵扯到数据库操作的程序)Input:/输入参数说明,包括每个参数的作输入参数说明,包括每个参数的作 /用、取值说明及参数间关系。用、取值说明及参数间关系。Output:/对输出参数的说明。对输出参数的说明。Return:/函数返回值的说明函数返回值的说明 Others:/其它说明其它说明*/C语言编程规范语

12、言编程规范2 注释注释2-5:边边写写代代码码边边注注释释,修修改改代代码码同同时时修修改改相相应应的的注注释释,以以保保证证注注释释与与代代码码的的一一致性。不再有用的注释要删除。致性。不再有用的注释要删除。2-6:注释的内容要清楚注释的内容要清楚、明了,含义准确,防止注释二义性。、明了,含义准确,防止注释二义性。2-7:避免在注释中使用缩写避免在注释中使用缩写,特别是非常用缩写。,特别是非常用缩写。说明:在使用缩写时或之前,应对缩写进行必要的说明。2-8:注注释释应应与与其其描描述述的的代代码码相相近近,对对代代码码的的注注释释应应放放在在其其上上方方或或右右方方(对对单单条条语语句句的的

13、注注释释)相相邻邻位位置置,不不可可放放在在下下面面,如如放放于于上上方方则则需需与与其其上上面面的的代代码码用用空行隔开空行隔开。C语言编程规范语言编程规范2 注释注释2-9:对对于于所所有有有有物物理理含含义义的的变变量量、常常量量,如如果果其其命命名名不不是是充充分分自自注注释释的的,在在声声明明时时都都必必须须加加以以注注释释,说说明明其其物物理理含含义义。变变量量、常常量量、宏宏的的注释应放在其上方相邻位置或右方。注释应放在其上方相邻位置或右方。2-10:数数据据结结构构声声明明(包包括括数数组组、结结构构、类类、枚枚举举等等),如如果果其其命命名名不不是是充充分分自自注注释释的的,

14、必必须须加加以以注注释释。对对结结构构中中的的每每个个域域的的注注释释放放在在此此域域的的右方右方。C语言编程规范语言编程规范2 注释注释示例:可按如下形式示例:可按如下形式说明说明枚举枚举/数据数据/联合结构联合结构。/*sccp interface with sccp user primitive 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 n

15、ot*/*transmission this message*/N_UNITDATA_REQ,/*sccp users unit data transmission request*/;C语言编程规范语言编程规范2 注释注释2-11:全全局局变变量量要要有有较较详详细细的的注注释释,包包括括对对其其功功能能、取取值值范范围围、哪哪些些函函数数或或过过程程存取它以及存取时注意事项等的说明。存取它以及存取时注意事项等的说明。2-12:注释与所描述内容进行同样的缩排。:注释与所描述内容进行同样的缩排。说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。void

16、 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*/CodeBlock TwoC语言编程规范语言编程规范2 注释注释2-13:将注释与其上面的代码用空行隔开。:将注释与其上面的代码用空行隔开。应如下书写应如下书写/*code one comments*/program code one/

17、*code two comments*/program code two示例:如下例子,显得代码过于紧凑。示例:如下例子,显得代码过于紧凑。/*code one comments*/program code one/*code two comments*/program code twoC语言编程规范语言编程规范2 注释注释2-14:对对变变量量的的定定义义和和分分支支语语句句(条条件件分分支支、循循环环语语句句等等)必必须须编编写写注注释释。2-15:对对于于switch语语句句下下的的case语语句句,如如果果因因为为特特殊殊情情况况需需要要处处理理完完一一个个case后后进进入入下下一一

18、个个case处处理理,必必须须在在该该case语语句句处处理理完完、下下一一个个case语语句句前前加加上上明明确确的的注注释释。说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。C语言编程规范语言编程规范2 注释注释2-1:避免在一行代码或表达式的中间插入注释。:避免在一行代码或表达式的中间插入注释。2-2:通过对函数或过程、变量、结构等:通过对函数或过程、变量、结构等正确的命名正确的命名以及合理地组织代码以及合理地组织代码的结构,使代码成为的结构,使代码成为自注释自注释的。的。说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。2-3:在:在代码的代

19、码的功能、意图功能、意图层次上进行注释层次上进行注释,提供有用、额外的信息。,提供有用、额外的信息。C语言编程规范语言编程规范2 注释注释2-4:在程序块的结束行右方加注释标记,以表明某:在程序块的结束行右方加注释标记,以表明某程序块的结束程序块的结束。2-5:注释格式尽量统一,建议使用:注释格式尽量统一,建议使用“/*/”。2-6:注注释释应应考考虑虑程程序序易易读读及及外外观观排排版版的的因因素素,使使用用的的语语言言若若是是中中、英英兼兼有的,有的,建议多使用中文建议多使用中文,除非能用非常流利准确的英文表达。,除非能用非常流利准确的英文表达。C语言编程规范语言编程规范3 3 标识符命名

20、标识符命名C语言编程规范语言编程规范3 3 标识符命名标识符命名3-1:标标识识符符的的命命名名要要清清晰晰、明明了了,有有明明确确含含义义,同同时时使使用用完完整整的的单单词词或或大家基本可以理解的缩写,避免使人产生误解。大家基本可以理解的缩写,避免使人产生误解。3-2:命名中:命名中若使用特殊约定或缩写若使用特殊约定或缩写,则,则要有注释说明要有注释说明。说明:应该在源文件的开始之处,对文件中所使用的缩写或约定,特殊的缩写,进行必要的注释说明 3-3:自己特有的:自己特有的命名命名风格,风格,要自始至终保持一致要自始至终保持一致,不可来回变化。,不可来回变化。C语言编程规范语言编程规范3

21、3 标识符命名标识符命名3-4:对对于于变变量量命命名名,禁禁止止取取单单个个字字符符(如如i、j、k.),建建议议除除了了要要有有具具体体含含义义外外,还还能能表表明明其其变变量量类类型型、数数据据类类型型等等,但但i、j、k作作局局部部循循环环变量是允许的变量是允许的。3-5:命名命名规规范范必必须须与所使用的系与所使用的系统风统风格保持一致,并格保持一致,并在同一在同一项项目中目中统统一一.C语言编程规范语言编程规范3 3 标识符命名标识符命名3-13-1:除非必要,:除非必要,不要用数字或较奇怪的字符不要用数字或较奇怪的字符来定义标识符。来定义标识符。3-23-2:在在同同一一软软件件

22、产产品品内内,应应规规划划好好接接口口部部分分标标识识符符(变变量量、结结构构、函函数及常量)的命名,防止编译、链接时产生冲突。数及常量)的命名,防止编译、链接时产生冲突。说明:对接口部分的标识符应该有更严格限制,防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。3-3 3-3:用:用正确的反义词组命名正确的反义词组命名具有互斥意义的变量或相反动作的具有互斥意义的变量或相反动作的函数函数等。等。C语言编程规范语言编程规范3 3 标识符命名标识符命名说明:下面是一些在软件中常用的反义词组。说明:下面是一些在软件中常用的反义词组。add/remove begin/end create/

23、destroy insert/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_

24、name);C语言编程规范语言编程规范3 3 标识符命名标识符命名3-4:除了编译:除了编译开关开关/头文件头文件等特殊应用,应等特殊应用,应避免使用避免使用_EXAMPLE_TEST_之类以之类以下划线下划线开始和结尾开始和结尾的定义的定义。C语言编程规范语言编程规范4 4 可读性可读性C语言编程规范语言编程规范4 4 可读性可读性4-1:注意运算符的优先级,:注意运算符的优先级,并用括号并用括号明确表达式的明确表达式的操作顺序操作顺序,避免使用默认优,避免使用默认优先级。先级。4-2:避免使用不易理解的数字避免使用不易理解的数字,用有意义的用有意义的标识标识来替代来替代。涉及物理状态或者含

25、。涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏枚举或宏来代替。来代替。4-3:源程序中关系较为紧密的代码应尽可能相邻。:源程序中关系较为紧密的代码应尽可能相邻。若按如下形式书写,可能更清晰一些。rect.length=10;rect.width=5;char_poi=str;说明:便于程序阅读和查找。示例:以下代码布局不太合理。rect.length=10;char_poi=str;rect.width=5;C语言编程规范语言编程规范4 4 可读性可读性4-4:不要使用难懂的技巧性很高的语句,除非很有必要时。:不

26、要使用难懂的技巧性很高的语句,除非很有必要时。C语言编程规范语言编程规范5 5 变量、结构变量、结构C语言编程规范语言编程规范5 5 变量、结构变量、结构5-1:去掉没必要的公共变量。:去掉没必要的公共变量。说明:公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间的耦合度。5-2:仔仔细细定定义义并并明明确确公公共共变变量量的的含含义义、作作用用、取取值值范范围围及及公公共共变变量量间间的关系。的关系。C语言编程规范语言编程规范5 5 变量、结构变量、结构5-3:明明确确公公共共变变量量与与操操作作此此公公共共变变量量的的函函数数或或过过程程的的关关系系,如如访访问问、修

27、改及创建等。修改及创建等。说明:明确过程操作变量的关系后,将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。C语言编程规范语言编程规范5 5 变量、结构变量、结构5-4:当当向向公公共共变变量量传传递递数数据据时时,要要十十分分小小心心,防防止止赋赋与与不不合合理理的的值值或或越越界界等等现象发生现象发生。5-5:防止防止局部变量与公共变量局部变量与公共变量同名同名。5-6:严禁使用:严禁使用未经初始化未经初始化的变量作为指针。的变量作为指针。说明:特别是在C/C+中引用未经赋值的指针,经常会引起系统崩溃。5-1:构构造造仅仅有有一一个个模模块块或

28、或函函数数可可以以修修改改、创创建建,而而其其余余有有关关模模块块或或函函数数只只访访问问的的公公共共变变量量,防止多个不同模块或函数都可以修改、创建同一公共变量的现象。,防止多个不同模块或函数都可以修改、创建同一公共变量的现象。说明:降低公共变量耦合度。C语言编程规范语言编程规范5 5 变量、结构变量、结构5-2:使使用用严严格格形形式式定定义义的的、可可移移植植的的数数据据类类型型,尽尽量量不不要要使使用用与与具具体体硬硬件件或或软件环境关系密切的软件环境关系密切的变量变量。说明:使用标准的数据类型,有利于程序的移植。示例:如下例子(在DOS下BC3.1环境中),在移植时可能产生问题。vo

29、id main()register int index;/寄存器变量 _AX=0 x4000;/_AX是BC3.1提供的寄存器“伪变量”./program codeC语言编程规范语言编程规范5 5 变量、结构变量、结构 5-3:结构的功能要单一,是针对一种事务的抽象。:结构的功能要单一,是针对一种事务的抽象。说明:结构中的各元素应代表同一事务的不同侧面,而不应把描述没有关系或关系很弱的不同事务的元素放到同一结构中。5-4:不要设计面面俱到、非常灵活的数据结构。:不要设计面面俱到、非常灵活的数据结构。说明:面面俱到、灵活的数据结构反而容易引起误解和操作困难。5-5:不同结构间的关系不要过于复杂。

30、:不同结构间的关系不要过于复杂。说明:若两个结构间关系较复杂、密切,那么应合为一个结构。5-6:结结构构中中元元素素的的个个数数应应适适中中。若若结结构构中中元元素素个个数数过过多多可可考考虑虑依依据据某某种种原原则则把元素组成不同的子结构把元素组成不同的子结构,以减少原结构中元素的个数。,以减少原结构中元素的个数。说明:增加结构的可理解性、可操作性和可维护性。C语言编程规范语言编程规范5 5 变量、结构变量、结构5-7:仔仔细细设设计计结结构构中中元元素素的的布布局局与与排排列列顺顺序序,使使结结构构容容易易理理解解、节节省省占占用用空空间,并减少引起误用现象。间,并减少引起误用现象。5-8

31、:结结构构的的设设计计要要尽尽量量考考虑虑向向前前兼兼容容和和以以后后的的版版本本升升级级,并并为为某某些些未未来来可可能能的应用保留余地(如预留一些空间等)。的应用保留余地(如预留一些空间等)。5-9:留心具体语言及编译器处理留心具体语言及编译器处理不同数据类型的原则不同数据类型的原则及有关细节及有关细节。说明:如在C语言中,static局部变量将在内存“数据区”中生成,而非static局部变量将在“堆栈”中生成。这些细节对程序质量的保证非常重要。5-10:编程时,要注意数据类型的:编程时,要注意数据类型的强制转换强制转换。说明:当进行数据类型强制转换时,其数据的意义、转换后的取值等都有可能

32、发生变化,而这些细节若考虑不周,就很有可能留下隐患。C语言编程规范语言编程规范5 5 变量、结构变量、结构5-11:对:对编译系统默认编译系统默认的数据类型转换,也要有充分的认识。的数据类型转换,也要有充分的认识。5-12:尽量:尽量减少没有必要减少没有必要的数据类型默认转换与强制转换。的数据类型默认转换与强制转换。5-13:合合理理地地设设计计数数据据并并使使用用自自定定义义数数据据类类型型,避避免免数数据据间间进进行行不不必必要的类型转换要的类型转换。5-14:对对自自定定义义数数据据类类型型进进行行恰恰当当命命名名,使使它它成成为为自自描描述述性性的的,以以提提高代码可读性高代码可读性。

33、注意其命名方式在同一产品中的统一。注意其命名方式在同一产品中的统一。C语言编程规范语言编程规范6 6 函数、过程函数、过程C语言编程规范语言编程规范6 6 函数、过程函数、过程6-1:对所调用函数的错误返回码要仔细、全面地处理对所调用函数的错误返回码要仔细、全面地处理。6-2:明确函数功能,:明确函数功能,精确精确(而不是近似)地实现函数设计。(而不是近似)地实现函数设计。6-3:编编写写可可重重入入函函数数时时,应应注注意意局局部部变变量量的的使使用用(如如编编写写C/C+语语言言的的可可重重入函数时,应使用入函数时,应使用auto即即缺省态局部变量缺省态局部变量或或寄存器变量寄存器变量)。

34、)。说明:编写C/C+语言的可重入函数时,不应使用static局部变量,否则必须经过特殊处理,才能使函数具有可重入性。6-4:编编写写可可重重入入函函数数时时,若若使使用用全全局局变变量量,则则应应通通过过关关中中断断、信信号号量量(即即P、V操作)操作)等手段对其加以等手段对其加以保护保护。说明:若对所使用的全局变量不加以保护,则此函数就不具有可重入性,即当多个进程调用此函数时,很有可能使有关全局变量变为不可知状态。C语言编程规范语言编程规范6 6 函数、过程函数、过程示例:假设Exam是int型全局变量,函数Squre_Exam返回Exam平方值。那么如下函数不具有可重入性。unsigne

35、d int example(int para)unsigned int temp;Exam=para;/(*)temp=Square_Exam();return temp;此函数若被多个进程调用的话,其结果可能是未知的,因为当(*)语句刚执行完后,另外一个使用本函数的进程可能正好被激活,那么当新激活的进程执行到此函数时,将使Exam赋与另一个不同的para值,所以当控制重新回到“temp=Square_Exam()”后,计算出的temp很可能不是预想中的结果。C语言编程规范语言编程规范6 6 函数、过程函数、过程此函数应如下改进。unsigned int example(int para)un

36、signed int temp;申请信号量操作 /若申请不到“信号量”,说明另外的进程正处于 Exam=para;/给Exam赋值并计算其平方过程中(即正在使用此 temp=Square_Exam();/信号),本进程必须等待其释放信号后,才可继 释放信号量操作 /续执行。若申请到信号,则可继续执行,但其 /它进程必须等待本进程释放信号量后,才能再使 /用本信号。return temp;C语言编程规范语言编程规范6 6 函数、过程函数、过程6-5:在在同同一一项项目目组组应应明明确确规规定定对对接接口口函函数数参参数数的的合合法法性性检检查查应应由由函函数数的的调调用用者者负责还是由负责还是由

37、接口函数本身接口函数本身负责,缺省是由负责,缺省是由函数调用者函数调用者负责。负责。说明:对于模块间接口函数的参数的合法性检查这一问题,往往有两个极端现象,即:要么是调用者和被调用者对参数均不作合法性检查,结果就遗漏了合法性检查这一必要的处理过程,造成问题隐患;要么就是调用者和被调用者均对参数进行合法性检查,这种情况虽不会造成问题,但产生了冗余代码,降低了效率。6-1:防止将函数的参数作为工作变量。:防止将函数的参数作为工作变量。说明:将函数的参数作为工作变量,有可能错误地改变参数内容,所以很危险。对必须改变的参数,最好先用局部变量代之,最后再将该局部变量的内容赋给该参数。C语言编程规范语言编

38、程规范6 6 函数、过程函数、过程示例:下函数的实现不太好。示例:下函数的实现不太好。void sum_data(unsigned int num,int*data,int*sum)unsigned int count;*sum=0;for(count=0;count num;count+)*sum +=datacount;/sum成了工成了工作变量,不太好。作变量,不太好。若改为如下,则更好些。若改为如下,则更好些。void sum_data(unsigned int num,int*data,int*sum)unsigned int count;int sum_temp;/在这定义了局部变

39、量在这定义了局部变量 sum_temp=0;for(count=0;count B-C-A),影响程序的可理解性;递归调用一般都占用较多的系统资源(如栈空间);递归调用对程序的测试有一定影响。故除非为某些算法或功能的实现方便,应减少没必要的递归调用。6-25:仔仔细细分分析析模模块块的的功功能能及及性性能能需需求求,并并进进一一步步细细分分,同同时时若若有有必必要要画画出有关数据流图出有关数据流图,据此来进行模块的函数划分与组织。,据此来进行模块的函数划分与组织。说明:函数的划分与组织是模块的实现过程中很关键的步骤,如何划分出合理的函数结构,关系到模块的最终效率和可维护性、可测性等。根据模块的

40、功能图或数据流图映射出函数结构是常用方法之一。C语言编程规范语言编程规范6 6 函数、过程函数、过程6-26:改改进进模模块块中中函函数数的的结结构构,降降低低函函数数间间的的耦耦合合度度,并并提提高高函函数数的的独独立立性性以以及代码可读性、效率和可维护性。优化函数结构时,要遵守以下原则:及代码可读性、效率和可维护性。优化函数结构时,要遵守以下原则:(1)不能影响模块)不能影响模块功能的实现功能的实现。(2)仔细考查)仔细考查模块模块或或函数出错处理函数出错处理及模块的性能要求并进行完善。及模块的性能要求并进行完善。(3)通过)通过分解或合并分解或合并函数来函数来改进软件结构改进软件结构。(

41、4)考查函数的)考查函数的规模,过大的要进行分解规模,过大的要进行分解。(5)降低函数间接口的复杂度降低函数间接口的复杂度。(6)不同层次的函数调用要有)不同层次的函数调用要有较合理的扇入、扇出较合理的扇入、扇出。(7)函数功能应可预测。)函数功能应可预测。(8)提高函数)提高函数内聚内聚。(单一功能的函数内聚最高)。(单一功能的函数内聚最高)说明:对初步划分后的函数结构应进行改进、优化,使之更为合理。C语言编程规范语言编程规范6 6 函数、过程函数、过程6-27:在多任务操作系统的环境下编程,要:在多任务操作系统的环境下编程,要注意函数可重入性的构造注意函数可重入性的构造。说明:可重入性是指

42、函数可以被多个任务进程调用。在多任务操作系统中,函数是否具有可重入性是非常重要的,因为这是多个进程可以共用此函数的必要条件。另外,编译器是否提供可重入函数库,与它所服务的操作系统有关,只有操作系统是多任务时,编译器才有可能提供可重入函数库。(如DOS下BC和MSC等就不具备可重入函数库,因为DOS是单用户单任务操作系统)。6-28:避免使用:避免使用BOOL参数。参数。(C语言中没有语言中没有BOOL)说明:原因有二,其一是BOOL参数值无意义,TURE/FALSE的含义是非常模糊的,在调用时很难知道该参数到底传达的是什么意思;其二是BOOL参数值不利于扩充。还有NULL也是一个无意义的单词。

43、C语言编程规范语言编程规范6 6 函数、过程函数、过程6-29:对于对于提供了返回值的函数提供了返回值的函数,在引用时最好,在引用时最好使用其返回值使用其返回值。6-30:当当一一个个过过程程(函函数数)中中对对较较长长变变量量(一一般般是是结结构构的的成成员员)有有较较多多引引用用时时,可以可以用一个意义相当的用一个意义相当的宏宏代替代替。说明:这样可以增加编程效率和程序的可读性。示例:在某过程中较多引用TheReceiveBufferFirstSocket.byDataPtr,则可以通过以下宏定义来代替:#define pSOCKDATA TheReceiveBufferFirstScok

44、et.byDataPtrC语言编程规范语言编程规范7 7 可测性可测性C语言编程规范语言编程规范7 7 可测性可测性7-1:在在同同一一项项目目组组或或产产品品组组内内,要要有有一一套套统统一一的的为为集集成成测测试试与与系系统统联联调调准准备备的的调测开关调测开关及相应打印函数,并且要有详细的说明。及相应打印函数,并且要有详细的说明。说明:本规则是针对项目组或产品组的。7-2:在在同同一一项项目目组组或或产产品品组组内内,调调测测打打印印出出的的信信息息串串的的格格式式要要有有统统一一的的形形式式。信息串中至少要有所在模块名(或源文件名)及行号。信息串中至少要有所在模块名(或源文件名)及行号

45、。说明:统一的调测信息格式便于集成测试。7-3:编编程程的的同同时时要要为为单单元元测测试试选选择择恰恰当当的的测测试试点点,并并仔仔细细构构造造测测试试代代码码、测测试试用用例例,同同时时给给出出明明确确的的注注释释说说明明。测测试试代代码码部部分分应应作作为为(模模块块中中的的)一一个个子子模块,以方便测试代码在模块中的安装与拆卸(通过调测开关)。模块,以方便测试代码在模块中的安装与拆卸(通过调测开关)。说明:为单元测试而准备。C语言编程规范语言编程规范7 7 可测性可测性7-4:在在进进行行集集成成测测试试/系系统统联联调调之之前前,要要构构造造好好测测试试环环境境、测测试试项项目目及及

46、测测试试用用例,同时仔细例,同时仔细分析并优化分析并优化测试用例,以提高测试效率。测试用例,以提高测试效率。说明:好的测试用例应尽可能模拟出程序所遇到的边界值、各种复杂环境及一些极端情况等。7-5:使用断言使用断言来发现软件问题,提高代码可测性。来发现软件问题,提高代码可测性。说明:断言是对某种假设条件进行检查(可理解为若条件成立则无动作,否则应报告),它可以快速发现并定位软件问题,同时对系统错误进行自动报警。断言可以对在系统中隐藏很深,用其它手段极难发现的问题进行定位,从而缩短软件问题定位时间,提高系统的可测性。实际应用时,可根据具体情况灵活地设计断言。C语言编程规范语言编程规范7 7 可测

47、性可测性示例:下面是示例:下面是C语言中的一个断言,用语言中的一个断言,用宏宏来设计的。(其中来设计的。(其中NULL为为0L)#ifdef _EXAM_ASSERT_TEST_ /若使用断言测试若使用断言测试void exam_assert(char*file_name,unsigned int line_no)printf(nEXAMAssert failed:%s,line%un,file_name,line_no);abort();#define EXAM_ASSERT(condition)if(condition)/若条件成立,则无动作若条件成立,则无动作 NULL;else /否则

48、报告否则报告 exam_assert(_FILE_,_LINE_)#else /若不使用断言测试若不使用断言测试#define EXAM_ASSERT(condition)NULL#endif /*end of ASSERT*/C语言编程规范语言编程规范7 7 可测性可测性7-6:用用断断言言来来检检查查程程序序正正常常运运行行时时不不应应发发生生但但在在调调测测时时有有可可能能发发生生的的非非法法情况。情况。7-7:不能用断言来检查最终产品:不能用断言来检查最终产品肯定会出现且必须处理的错误肯定会出现且必须处理的错误情况。情况。说明:断言是用来处理不应该发生的错误情况的,对于可能会发生的且必

49、须处理的情况要写防错程序,而不是断言。如某模块收到其它模块或链路上的消息后,要对消息的合理性进行检查,此过程为正常的错误检查,不能用断言来实现。7-8:对较复杂的断言加上明确的注释。:对较复杂的断言加上明确的注释。说明:为复杂的断言加注释,可澄清断言含义并减少不必要的误用。C语言编程规范语言编程规范7 7 可测性可测性7-9:用:用断言断言确认函数的参数。确认函数的参数。示例:假设某函数参数中有一个指针,那么使用指针前可对它检查,如下。示例:假设某函数参数中有一个指针,那么使用指针前可对它检查,如下。int exam_fun(unsigned char*str)EXAM_ASSERT(str!

50、=NULL);/用断言检查“假设指针不为空”这个条件 ./other program codeC语言编程规范语言编程规范7 7 可测性可测性7-10:用断言:用断言保证保证没有定义没有定义的特性或功能不被使用。的特性或功能不被使用。示例:假设某通信模块在设计时,准备提供“无连接”和“连接”这两种业务。但当前的版本中仅实现了“无连接”业务,且在此版本的正式发行版中,用户(上层模块)不应产生“连接”业务的请求,那么在测试时可用断言检查用户是否使用“连接”业务。如下。#define EXAM_CONNECTIONLESS 0/无连接业务无连接业务#define EXAM_CONNECTION 1/连

展开阅读全文
相关资源
相关搜索

当前位置:首页 > 技术资料 > 其他杂项

本站为文档C TO C交易模式,本站只提供存储空间、用户上传的文档直接被用户下载,本站只是中间服务平台,本站所有文档下载所得的收益归上传人(含作者)所有。本站仅对用户上传内容的表现方式做保护处理,对上载内容本身不做任何修改或编辑。若文档所含内容侵犯了您的版权或隐私,请立即通知淘文阁网,我们立即给予删除!客服QQ:136780468 微信:18945177775 电话:18904686070

工信部备案号:黑ICP备15003705号© 2020-2023 www.taowenge.com 淘文阁