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

单击此处编辑母版标题样式,单击此处编辑母版文本样式,第二级,第三级,第四级,第五级,C,语言编程规范,参考华为软件编程规范,主要内容,C,语言编程规范,1,排版,2,注释,3,标识符命名,4,可读性,5,变量、结构,6,函数、过程,7,可测性,8,程序效率,9,质量保证,10,代码编辑、编译、审查,11,代码测试、维护,12,宏,C,语言编程规范,1 排版,C,语言编程规范,1 排版,1-1,：程序块要采用缩进风格编写，缩进的空格数为,4,个。,1-2,：相对独立的程序块之间、变量说明之后必须加空行。,1-3,：较长的语句（,80,字符）要,分成多行书写,，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使,排版整齐,，语句可读。,report_or_not_flag=(taskno MAX_ACT_TASK_NUMBER),&(n7stat_stat_item_valid(stat_item),C,语言编程规范,1 排版,1-4,：循环、判断等语句中若有,较长的表达式或语句，则要进行适应的划分,，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。,示例：,if(taskno max_act_task_number),&(n7stat_stat_item_valid(stat_item),./program code,for(i=0,j=0;(i,），后不应加空格。,说明：采用这种松散方式编写代码的目的是,使代码更加清晰,。,由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格,.,如,括号内侧,(,即左括号后面和右括号前面,),不需要加空格，多重括号间不必加空格，因为在,C/C+,语言中括号已经是最清晰的标志了。,在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。,C,语言编程规范,1 排版,(1),逗号、分号只在后面加空格。,int a,b,c;,(2),比较操作符,赋值操作符,=,、,+=,，算术操作符,+,、,%,，逻辑操作符,&,、,&,，位域操作符,=MAX_TIME_VALUE),a=b+c;,a*=2;,a=b 2;,C,语言编程规范,1 排版,(3)!,、,、,+,、,-,、,&,（地址运算符）等,单目操作符,前后不加空格。,*,p=a;/,内容操作,*,与内容之间,flag=,!,isEmpty;/,非操作,!,与内容之间,p=/,地址操作,&,与内容之间,i+;/+,-,与内容之间,(4)-,、,.,前后不加空格。,p-id=pid;/-,指针前后不加空格,(5)if,、,for,、,while,、,switch,等与后面的括号间应加空格，,使,if,等关键字更为突出、明显,。,if(a=b&c d),C,语言编程规范,2,注释,C,语言编程规范,2,注释,2-1,：一般情况下，源程序有效注释量必须在,20,以上。,C,语言编程规范,2,注释,/*,Copyright(C),1988-1999,Huawei Tech.Co.,Ltd.,File name:/,文件名,Author:Version:Date:/,作者、版本及完成日期,Description:/,用于详细说明此程序文件完成的主要功能，与其他模块,/,或函数的接口，输出值、取值范围、含义及参数间的控,/,制、顺序、独立或依赖等关系,Others:/,其它内容的说明,Function List:/,主要函数列表，每条记录应包括函数名及功能简要说明,1.,History:/,修改历史记录列表，每条修改记录应包括修改日期、修改,/,者及修改内容简述,1.Date:,Author:,Modification:,2.,*/,2-2,：,说明性文件,（如头文件,.h,文件、,.inc,文件、,.def,文件、编译说明文件,.cfg,等）头部应,进行注释,，注释必须列出：,版权说明,、,版本号,、,生成日期,、,作者,、,内容,、,功能,、,与其它文件的关系,、,修改日志,等，头文件的注释中还应有,函数功能简要说明,。,C,语言编程规范,2,注释,2-3,：,源文件,头部,应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的,/,功能、主要函数及其功能、修改日志等。,示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。,C,语言编程规范,2,注释,说明：,Description,一项描述本文件的,内容、功能、,内部各部分之间的关系,及,本文件与其它文件关系,等。,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 build this moudle,*/,C,语言编程规范,2,注释,2-4,：,函数,头部,应进行注释，列出：函数的目的,/,功能、输入参数、输出参数、返回值、调用关系（函数、表）等。,示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。,/*,Function:/,函数名称,Description:/,函数,功能、性能,等的描述,Calls:/,被本函数调用的函数清单,Called By:/,调用本函数的函数清单,Table Accessed:/,被访问的表（此项仅对于牵扯到数据库操作的程序）,Table Updated:/,被修改的表（此项仅对于牵扯到数据库操作的程序）,Input:/,输入参数说明，包括每个参数的作,/,用、取值说明及参数间关系。,Output:/,对输出参数的说明。,Return:/,函数返回值的说明,Others:/,其它说明,*,/,C,语言编程规范,2,注释,2-5,：,边写代码边注释,，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。,2-6,：,注释的内容要清楚,、明了，含义准确，防止注释二义性。,2-7,：,避免在注释中使用缩写,，特别是非常用缩写。,说明：在使用缩写时或之前，应对缩写进行必要的说明。,2-8,：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，,不可放在下面,，,如放于上方则需与其上面的代码用空行隔开,。,C,语言编程规范,2,注释,2-9,：对于所有,有物理含义的,变量、常量，如果其命名不是充分,自注释,的，在声明时都必须加以注释，,说明其物理含义,。变量、常量、宏的注释应放在其上方相邻位置或右方。,2-10,：,数据结构,声明,(,包括数组、结构、类、枚举等,),，如果,其命名不是充分自注释的，必须加以注释,。对结构中的,每个域的注释放在此域的右方,。,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 not*/,/*transmission this message*/,N_UNITDATA_REQ,/*sccp users unit data transmission request*/,;,C,语言编程规范,2,注释,2-11,：,全局变量要有较详细的注释,，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。,2-12,：注释与所描述内容进行同样的缩排。,说明：可使程序排版整齐，并方便注释的阅读与理解。,示例：如下例子，排版不整齐，阅读稍感不方便。,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*/,CodeBlock Two,C,语言编程规范,2,注释,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,C,语言编程规范,2,注释,2-14,：对,变量的定义和分支语句,（条件分支、循环语句等）,必须编写注释,。,2-15,：对于,switch,语句下的,case,语句，如果因为特殊情况需要处理完一个,case,后进入下一个,case,处理，,必须在该,case,语句处理完、下一个,case,语句前加上明确的注释,。,说明：这样比较清楚程序编写者的意图，,有效防止无故遗漏,break,语句,。,C,语言编程规范,2,注释,2-1,：避免在一行代码或表达式的中间插入注释。,2-2,：通过对函数或过程、变量、结构等,正确的命名,以及合理地组织代码的结构，使代码成为,自注释,的。,说明：清晰准确的函数、变量等的命名，可,增加代码可读性,，并减少不必要的注释。,2-3,：在,代码的,功能、意图,层次上进行注释,，提供有用、额外的信息。,C,语言编程规范,2,注释,2-4,：在程序块的结束行右方加注释标记，以表明某,程序块的结束,。,2-5,：注释格式尽量统一，建议使用“,/*,*/,”,。,2-6,：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，,建议多使用中文,，除非能用非常流利准确的英文表达。,C,语言编程规范,3 标识符命名,C,语言编程规范,3,标识符命名,3-1,：标识符的,命名要清晰、明了，有明确含义,，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。,3-2,：命名中,若使用特殊约定或缩写,，则,要有注释说明,。,说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特殊的缩写，进行必要的注释说明,3-3,：自己特有的,命名,风格，,要自始至终保持一致,，不可来回变化。,C,语言编程规范,3,标识符命名,3-4,：对于变量命名，,禁止取单个字符,（如,i,、,j,、,k.,），建议除了要有具体含义外，还能表明其变量类型、数据类型等，,但,i,、,j,、,k,作局部循环变量是允许的,。,3-5,：,命名规范,必须与所使用的系统风格保持一致，并,在同一项目中统一,.,C,语言编程规范,3,标识符命名,3-1,：除非必要，,不要用数字或较奇怪的字符,来定义标识符。,3-2,：在同一软件产品内，应,规划好接口部分标识符,（变量、结构、函数及常量）的命名，防止编译、链接时产生冲突。,说明：对接口部分的标识符应该有更严格限制，,防止冲突,。如可规定接口部分的变量与常量之前加上,“,模块,”,标识等。,3-3,：用,正确的反义词组命名,具有互斥意义的变量或相反动作的,函数,等。,C,语言编程规范,3,标识符命名,说明：下面是一些在软件中常用的反义词组。,add/remove begin/end create/destroy,insert/delete first/last get/release,increment/decrement put/get,add/delete lock/unlock open/close,min/max old/new start/stop,next/previous source/target show/hide,send/receive source/destination,cut/paste up/down,示例：,int min_sum;,int max_sum;,int add_user(BYTE*user_name);,int delete_user(BYTE*user_name);,C,语言编程规范,3,标识符命名,3-4,：除了编译,开关,/,头文件,等特殊应用，应,避免使用,_,EXAMPLE_TEST,_,之类以下划线,开始和结尾,的定义,。,C,语言编程规范,4 可读性,C,语言编程规范,4 可读性,4-1,：注意运算符的优先级，,并用括号,明确表达式的,操作顺序,，避免使用默认优先级。,4-2,：,避免使用不易理解的数字,，,用有意义的,标识,来替代,。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的,枚举或宏,来代替。,4-3,：源程序中关系较为紧密的代码应尽可能相邻。,若按如下形式书写，可能更清晰一些。,rect.length=10;rect.width=5;,char_poi=str;,说明：便于程序阅读和查找。,示例：以下代码布局不太合理。,rect.length=10;,char_poi=str;,rect.width=5;,C,语言编程规范,4 可读性,4-4,：不要使用难懂的技巧性很高的语句，除非很有必要时。,C,语言编程规范,5,变量、结构,C,语言编程规范,5 变量、结构,5-1,：去掉没必要的公共变量。,说明：公共变量是增大,模块间耦合,的原因之一，故应减少没必要的公共变量,以降低模块间的,耦合度,。,5-2,：仔细定义并,明确公共变量,的含义、作用、取值范围及公共变量间的关系。,C,语言编程规范,5 变量、结构,5-3,：明确,公共变量,与操作此公共变量的,函数或过程,的,关系,，如访问、修改及创建等。,说明：明确过程操作变量的关系后，将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。,C,语言编程规范,5 变量、结构,5-4,：当,向公共变量传递数据,时，要十分小心，,防止赋与不合理的值或越界等现象发生,。,5-5,：,防止,局部变量与公共变量,同名,。,5-6,：严禁使用,未经初始化,的变量作为指针。,说明：特别是在,C/C+,中引用未经赋值的指针，经常会引起系统崩溃。,5-1,：构造,仅有一个模块或函数可以修改、创建,，,而其余有关模块或函数只访问的,公共变量,，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。,说明：降低公共变量耦合度。,C,语言编程规范,5 变量、结构,5-2,：使用严格形式定义的、可移植的数据类型，尽量,不要使用与具体硬件或软件环境关系密切的,变量,。,说明：使用标准的数据类型，有利于程序的移植。,示例：如下例子（在,DOS,下,BC3.1,环境中），在移植时可能产生问题。,void main(),register int index;/,寄存器变量,_AX,=0 x4000;/_AX,是,BC3.1,提供的寄存器“伪变量”,./program code,C,语言编程规范,5 变量、结构,5-3,：结构的功能要单一，是针对一种事务的抽象。,说明：结构中的各元素应代表同一事务的不同侧面，而,不应把描述没有关系或关系很弱的不同事务的元素放到同一结构中,。,5-4,：不要设计面面俱到、非常灵活的数据结构。,说明：面面俱到、灵活的数据结构反而,容易引起误解和操作困难,。,5-5,：不同结构间的关系不要过于复杂。,说明：若两个结构间,关系较复杂,、密切，那么,应合为一个结构,。,5-6,：结构中元素的个数应适中。若结构中,元素个数过多可考虑依据某种原则把元素组成不同的子结构,，以减少原结构中元素的个数。,说明：增加结构的可理解性、可操作性和可维护性。,C,语言编程规范,5 变量、结构,5-7,：仔细设计结构中,元素的布局与排列顺序,，使结构容易理解、节省占用空间，并减少引起误用现象。,5-8,：结构的设计要尽量,考虑向前兼容和以后的版本升级,，并为某些未来可能的应用保留余地（如预留一些空间等）。,5-9,：,留心具体语言及编译器处理,不同数据类型的原则,及有关细节,。,说明：如在,C,语言中，,static,局部变量将在内存“数据区”中生成，而非,static,局部变量将在“堆栈”中生成。这些细节对程序质量的保证非常重要,。,5-10,：编程时，要注意数据类型的,强制转换,。,说明：当进行数据类型强制转换时，其,数据的意义、转换后的取值,等都有可能,发生变化,，而这些细节若考虑不周，就很有可能留下隐患。,C,语言编程规范,5 变量、结构,5-11,：对,编译系统默认,的数据类型转换，也要有充分的认识。,5-12,：尽量,减少没有必要,的数据类型默认转换与强制转换。,5-13,：合理地,设计,数据并使用自定义数据类型，,避免数据间进行不必要的类型转换,。,5-14,：对自定义,数据类型,进行,恰当命名,，使它成为,自描述性,的，以,提高代码可读性,。注意其命名方式在同一产品中的统一。,C,语言编程规范,6,函数、过程,C,语言编程规范,6 函数、过程,6-1,：,对所调用函数的错误返回码要仔细、全面地处理,。,6-2,：明确函数功能，,精确,（而不是近似）地实现函数设计。,6-3,：编写可重入函数时，应注意局部变量的使用（如编写,C/C+,语言的可重入函数时，应使用,auto,即,缺省态局部变量,或,寄存器变量,）。,说明：编写,C/C+,语言的可重入函数时，不应使用,static,局部变量，否则必须经过特殊处理，才能使函数具有可重入性。,6-4,：编写可重入函数时，,若使用全局变量,，则应通,过关中断、信号量（即,P,、,V,操作）,等手段对其加以,保护,。,说明：,若对所使用的全局变量不加以保护，则此函数就不具有可重入性,，即,当多个进程调用此函数时，很有可能使有关全局变量变为不可知状态,。,C,语言编程规范,6 函数、过程,示例：假设,Exam,是,int,型全局变量,，函数,Squre_Exam,返回,Exam,平方值。那么如下函数不具有可重入性。,unsigned int example(int para),unsigned int temp;,Exam,=para;/,（,*,）,temp=Square_Exam();,return temp;,此函数若被多个进程调用的话，其结果可能是未知的，因为当（,*,）语句刚执行完后，另外一个使用本函数的进程可能正好被激活，那么当新激活的进程执行到此函数时，将使,Exam,赋与另一个不同的,para,值，所以当控制重新回到“,temp=Square_Exam(),”,后，计算出的,temp,很可能不是预想中的结果。,C,语言编程规范,6 函数、过程,此函数应如下改进。,unsigned int example(int para),unsigned int temp;,申请,信号量操作,/,若申请不到“信号量”，说明另外的进程正处于,Exam=para;/,给,Exam,赋值并计算其平方过程中（即正在使用此,temp=Square_Exam();/,信号），本进程必须等待其释放信号后，才可继,释放,信号量操作,/,续执行。若申请到信号，则可继续执行，但其,/,它进程必须等待本进程释放信号量后，才能再使,/,用本信号。,return temp;,C,语言编程规范,6 函数、过程,6-5,：在同一项目组应明确规定,对,接口函数参数,的合法性检查,应由,函数的调用者,负责还是由,接口函数本身,负责，缺省是由,函数调用者,负责。,说明：对于模块间接口函数的参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患；要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。,6-1,：防止将函数的参数作为工作变量。,说明：将函数的参数,作为工作变量，有可能错误地改变参数内容,，所以很危险。对,必须改变的参数，最好,先用局部变量代之,，最后再将该局部变量的内容赋给该参数,。,C,语言编程规范,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;/,在这定义了局部变量,sum_temp=0;,for(count=0;count B-C-A,），,影响程序的可理解性,；递归调用一般都,占用较多的系统资源,（如栈空间）；递归调用,对程序的测试有一定影响,。故除非为某些算法或功能的实现方便，应减少没必要的递归调用。,6-25,：仔细,分析模块的功能及性能需求,，并进一步细分，同时若有必要,画出有关数据流图,，据此来进行模块的函数划分与组织。,说明：函数的划分与组织是模块的实现过程中很关键的步骤，如何划分出合理的函数结构，关系到模块的最终效率和可维护性、可测性等。根据模块的,功能图,或,数据流图,映射出函数结构是常用方法之一。,C,语言编程规范,6 函数、过程,6-26,：,改进模块中函数的结构，降低函数间的,耦合度,，并提高函数的独立性以及代码可读性、效率和可维护性。优化函数结构时，要遵守以下原则：,（,1,）不能影响模块,功能的实现,。,（,2,）仔细考查,模块,或,函数出错处理,及模块的性能要求并进行完善。,（,3,）通过,分解或合并,函数来,改进软件结构,。,（,4,）考查函数的,规模，过大的要进行分解,。,（,5,）,降低函数间接口的复杂度,。,（,6,）不同层次的函数调用要有,较合理的扇入、扇出,。,（,7,）函数功能应可预测。,（,8,）提高函数,内聚,。（单一功能的函数内聚最高）,说明：对初步划分后的函数结构应进行改进、优化，使之更为合理。,C,语言编程规范,6 函数、过程,6-27,：在多任务操作系统的环境下编程，要,注意函数可重入性的构造,。,说明：,可重入性是指函数可以被多个任务进程调用。,在多任务操作系统中，函数是否具有可重入性是非常重要的，因为这是多个进程可以共用此函数的必要条件。另外，编译器是否提供可重入函数库，与它所服务的操作系统有关，只有,操作系统是多任务时，编译器才有可能提供可重入函数库,。,(,如,DOS,下,BC,和,MSC,等就不具备可重入函数库，因为,DOS,是单用户单任务操作系统,),。,6-28,：避免使用,BOOL,参数。,(,C,语言中没有,BOOL),说明：原因有二，,其一,是,BOOL,参数值无意义，,TURE/FALSE,的含义是非常模糊的，在调用时很难知道该参数到底传达的是什么意思；,其二,是,BOOL,参数值不利于扩充。还有,NULL,也是一个无意义的单词。,C,语言编程规范,6 函数、过程,6-29,：,对于,提供了返回值的函数,，在引用时最好,使用其返回值,。,6-30,：当一个过程（函数）中对,较长变量,（一般是结构的成员）有,较多引用,时，可以,用一个意义相当的,宏,代替,。,说明：这样可以增加编程效率和程序的可读性。,示例：在某过程中较多引用,TheReceiveBufferFirstSocket.byDataPtr,，,则可以通过以下,宏定义,来代替：,#define,pSOCKDATA,TheReceiveBufferFirstScoket.byDataPtr,C,语言编程规范,7,可测性,C,语言编程规范,7 可测性,7-1,：在同一项目组或产品组内，要有一套统一的为集成测试与系统联调准备的,调测开关,及相应打印函数，并且要有详细的说明。,说明：本规则是针对项目组或产品组的。,7-2,：在同一项目组或产品组内，,调测,打印出的,信息串的格式要有统一,的形式。信息串中至少要有所在模块名（或源文件名）及行号。,说明：统一的调测信息格式便于集成测试。,7-3,：编程的同时要为单元测试,选择恰当的,测试点,，并仔细,构造,测试代码、测试用例,，同时给出,明确的注释说明,。测试代码部分应作为（模块中的）一个子模块，以方便测试代码在模块中的安装与拆卸（通过调测开关）。,说明：为单元测试而准备。,C,语言编程规范,7 可测性,7-4,：在进行集成测试,/,系统联调之前，要,构造好,测试环境、测试项目及测试用例，同时仔细,分析并优化,测试用例，以提高测试效率。,说明：好的测试用例应尽可能模拟出程序所遇到的边界值、各种复杂环境及一些极端情况等。,7-5,：,使用断言,来发现软件问题，提高代码可测性。,说明：,断言是对某种假设条件进行检查（可理解为若条件成立则无动作，否则应报告），,它可以快速发现并定位软件问题，同时对系统错误进行自动报警。断言可以对在系统中隐藏很深，用其它手段极难发现的问题进行定位，从而缩短软件问题定位时间，提高系统的可测性。实际应用时，可根据具体情况灵活地设计断言。,C,语言编程规范,7 可测性,示例：下面是,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 /,否则报告,exam_assert(,_FILE_,_LINE_,),#else /,若不使用断言测试,#define EXAM_ASSERT(condition)NULL,#endif /*end of ASSERT*/,C,语言编程规范,7 可测性,7-6,：用断言来检查程序正常运行时不应发生但在调测时有可能发生的非法情况。,7-7,：不能用断言来检查最终产品,肯定会出现且必须处理的错误,情况。,说明：,断言是用来处理不应该发生的错误情况的,，对于可能会发生的且必须处理的情况要,写防错程序,，而不是断言。如某模块收到其它模块或链路上的消息后，要对消息的合理性进行检查，此过程为正常的错误检查，不能用断言来实现。,7-8,：对较复杂的断言加上明确的注释。,说明：为复杂的断言加注释，可澄清断言含义并减少不必要的误用。,C,语言编程规范,7 可测性,7-9,：用,断言,确认函数的参数。,示例：假设某函数参数中有一个指针，那么使用指针前可对它检查，如下。,int exam_fun(unsigned char*str),EXAM_ASSERT(str!=NULL);/,用断言检查“,假设指针不为空,”这个条件,./other program code,C,语言编程规范,7 可测性,7-10,：用断言,保证,没有定义,的特性或功能不被使用。,示例：假设某通信模块在设计时，准备提供“无连接”和“连接”,这两种业务。但当前的版本中仅实现了“无连接”业务，且在此版本的正式发行版中，用户（上层模块）不应产生“连接”业务的请求，那么在测试时可用断言检查用户是否使用“连接”业务。如下。,#define EXAM_CONNECTIONLESS 0/,无连接业务,#define EXAM_CONNECTION 1/,连接业务,int msg_process(EXAM_MESSAGE*msg),unsigned char service;/*message service class*/,EXAM_ASSERT(msg!=NULL);,service=get_msg_service_class(msg);,EXAM_ASSERT(service!=EXAM_CONNECTION);/,假设不使用连接业务,./other program code,C,语言编程规范,7 可测性,7-11,：用断言对,程序开发环境（,OS/Compiler/Hardware,）的假设,进行检查。,说明：程序运行时所需的软硬件环境及配置要求，不能用断言来检查，而必须由一段专门代码处理。用断言仅可对程序开发环境中的假设及所配置的某版本软硬件是否具有某种功能的假设进行检查。如某网卡是否在系统运行环境中配置了，应由程序中正式代码来检查；而此网卡是否具有某设想的功能，则可由断言来检查。,对编译器提供的功能及特性假设可用断言检查，原因是软件最终产品（即运行代码或机器码）与编译器已没有任何直接关系，即软件运行过程中（注意不是编译过程中）不会也不应该对编译器的功能提出任何需求。,示例：用断言检查编译器的,int,型数据占用的内存空间是否为,2,，如下。,EXAM_ASSERT(sizeof(int)=2);,7-12,：正式软件产品中应把,断言及其它调测代码,去掉（即把有关的调测开关关掉）。,说明：加快软件运行速度。,C,语言编程规范,7 可测性,7-13,：在软件系统中设置与取消有关测试手段，不能对软件实现的功能等产生影响。,说明：即有测试代码的软件和关掉测试代码的软件，在功能行为上应一致。,7-14,：用调测开关来切换软件的,DEBUG,版和正式版，而不要同时存在正式版本和,DEBUG,版本的不同源文件，以减少维护的难度。,7-15,：软件的,DEBUG,版本和发行版本应该统一维护，不允许分家，并且要时刻注意保证两个版本在实现功能上的一致性。,C,语言编程规范,7 可测性,7-1,：,在编写代码之前，应预先设计好程序调试与测试的方法和手段，并设计好各种调测开关及相应测试代码如打印函数,等。,说明：程序的调试与测试是软件生存周期中很重要的一个阶段，如何对软件进行较全面、高率的测试并尽可能地找出软件中的错误就成为很关键的问题。因此在编写源代码之前，除了要有一套比较完善的测试计划外，还应设计出一系列代码测试手段，为单元测试、集成测试及系统联调提供方便。,7-2,：调测开关应分为不同级别和类型。,说明：调测开关的设置及分类应从以下几方面考虑：针对模块或系统某部分,代码的调测,；针对模块或系统,某功能的调测,；出于某种其它目的，如对,性能,、,容量,等的测试。这样做便于软件功能的调测，并且便于模块的单元测试、系统联调等。,C,语言编程规范,7 可测性,7-3,：编写防错程序，然后在处理错误之后可用断言宣布发生错误。,示例：假如某模块,收到,通信链路上的,消息,，则应对消息的,合法性进行检查,，若消息类别,不是通信协议中规定,的，则应进行,出错处理,，之后,可用断言报告,，如下例。,C,语言编程规范,7 可测性,#ifdef _EXAM_ASSERT_TEST_/,若使用断言测试,/*Notice:this function does not call abort to exit program*/,void assert_report(char*file_name,unsigned int line_no),printf(nEXAMError Report:%s,line%un,file_name,line_no);,#define ASSERT_REPORT(condition),if(condition)/,若条件成立，则无动作,NULL;,else/,否则报告,assert_report(_FILE_,_LINE_),#else/,若不使用断言测试,#define ASSERT_REPORT(condition)NULL,#endif/*end of ASSERT*/,int msg_handle(unsigned char msg_name,unsigned char*msg),switch(msg_name),case MSG_ONE:,./,消息,MSG_ONE,处理,return MSG_HANDLE_SUCCESS;,.,/,其它合法消息处理,default:,./,消息出错处理,ASSERT_REPORT(FALSE);/,“,合法”消息不成立，报告,return MSG_HANDLE_ERROR;,C,语言编程规范,8,程序效率,C,语言编程规范,8 程序效率,8-1,：编程时要经常注意代码的效率。,说明：代码效率分为,全局效率,、,局部效率,、,时间效率,及,空间效率,。全局效率是站在整个系统的角度上的系统效率；局部效率是站在模块或函数角度上的效率；时间效率是程序处理输入任务所需的时间长短；空间效率是程序所需内存空间，如机器代码空间大小、数据空间大小、栈空间大小等。,8-2,：在保证软件系统的正确性、稳定性、可读性及可测性的,前提下,，提高代码效率。,说明：不能一味地追求代码效率，而对软件的正确性、稳定性、可读性及可测性造成影响。,8-3,：,局部效率应为全局效率服务,，不能因为提高局部效率而对全局效率造成影响。,C,语言编程规范,8 程序效率,8-4,：通过对系统数据结构的划分与组织的改进，以及对程序算法的优化来提高空间效率。,说明：这种方式是解决软件空间效率的根本办法。,typedef struct STUDENT_STRU,BYTE name8;,BYTE age;,BYTE sex;,BYTE class;,STUDENT;,typedef struct STUDENT_SCORE_STRU,WORD student_index;,BYTE subject;,float score;,STUDENT_SCORE;,示例：如下记录学生学习成绩的结构不合理。,typedef unsigned char BYTE;,typedef unsigned short WORD;,typedef struct STUDENT_SCORE_STRU,BYTE name8;,BYTE age;,BYTE sex;,BYTE class;,BYTE subject;,float score;,STUDENT_SCORE;,因为每位学生都有多科学习成绩，故如上结构将占用较大空间。,应如下改进,（分为两个结构），总的存贮空间将变小,，操作也变得更方便。,C,语言编程规范,8 程序效率,8-5,：循环体内工作量最小化。,说明：应仔细考虑循环体内的语句是否可以放在循环体之外,，使循环体内工作量最小,，从而提高程序的时间效率。,示例：如下代码效率不高。,for(ind=0;ind MAX_ADD_NUMBER;ind+),sum+=ind;,back_sum=sum;/*backup sum*/,语句“,back_sum=sum;,”,完全可以放在,for,语句之后，如下。,for(ind=0;ind MAX_ADD_NUMBER;ind+),sum+=ind;,back_sum =sum;/*backup sum*/,C,语言编程规范,8 程序效率,8-1,：仔细分析有关算法，并进行,优化,。,8-2,：仔细考查、分析系统及模块处理输入（如事务、消息等）的方式，并加以