经典C编程规范完整篇.ppt

《经典C编程规范完整篇.ppt》由会员分享，可在线阅读，更多相关《经典C编程规范完整篇.ppt（114页珍藏版）》请在三一办公上搜索。

1、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_

2、ACT_TASK_NUMBER),C语言编程规范,1 排版,1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。示例：if(taskno max_act_task_number)i+,j+)./program code,C语言编程规范,1 排版,1-5：若函数或过程中的参数较长，则要进行适当的划分。示例：n7stat_str_compare(BYTE*)1-6：不允许把多个短语句写在一行中，即一行只写一条语句。,C语言编程规范,1 排版,1-7：if、for、do、while、case、switch、default等语

3、句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号。1-8：对齐只使用空格键，不使用TAB键。说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐，不要使用BC作为编辑器合版本，因为BC会自动将8个空格变为一个TAB键，因此使用BC合入的版本大多会将缩进变乱。1-9：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。,C语言编程规范,1 排版,1-10：程序块的分界符（如C/C+语言的大括号和）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体

4、的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。,示例：如下例子不符合规范。for(.)./program codeif(.)./program code void example_fun(void)./program code,应如下书写for(.)./program codeif(.)./program codevoid example_fun(void)./program code,C语言编程规范,1 排版,1-11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空

5、格；进行非对等操作时，如果是关系密切的立即操作符（如），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格.如括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。,C语言编程规范,1 排版,(1)逗号、分号只在后面加空格。int a,b,c;(2)比较操作符,赋值操作符=、+=，算术操作符+、%，逻辑操作符,C语言编程规

6、范,1 排版,(3)!、+、-、/-指针前后不加空格(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:/用于详细说明此程序文件完成的主要功能，与其他模块/或函数的接口，输出值、取值范围、

7、含义及参数间的控/制、顺序、独立或依赖等关系 Others:/其它内容的说明 Function List:/主要函数列表，每条记录应包括函数名及功能简要说明 1.History:/修改历史记录列表，每条修改记录应包括修改日期、修改/者及修改内容简述 1.Date:Author:Modification:2.*/,2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。,C语言编程规范,2 注释,2-3：源文件头部应进行

8、注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。,C语言编程规范,2 注释,说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。,/*Copyright(C),1988-1999,Huawei Tech.Co.,Ltd.FileName:test.cpp Author:Version:Date:Description:/模块描述 V

9、ersion:/版本信息 Function List:/主要函数及其功能 1.-History:/历史修改记录 David 96/10/12 1.0 build this moudle*/,C语言编程规范,2 注释,2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/*Function:/函数名称 Description:/函数功能、性能等的描述 Calls:/被本函数调用的函数清单 Called By:/调用本函数的函数清单 Table Accessed:

10、/被访问的表（此项仅对于牵扯到数据库操作的程序）Table Updated:/被修改的表（此项仅对于牵扯到数据库操作的程序）Input:/输入参数说明，包括每个参数的作/用、取值说明及参数间关系。Output:/对输出参数的说明。Return:/函数返回值的说明 Others:/其它说明*/,C语言编程规范,2 注释,2-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。2-6：注释的内容要清楚、明了，含义准确，防止注释二义性。2-7：避免在注释中使用缩写，特别是非常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。2-8：注释应与其描述的

11、代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。,C语言编程规范,2 注释,2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。2-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对结构中的每个域的注释放在此域的右方。,C语言编程规范,2 注释,示例：可按如下形式说明枚举/数据/联合结构。/*sccp interface with sccp user primitive m

12、essage 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：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注

13、意事项等的说明。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：将注释与其上面的代码用空行隔开。

14、,应如下书写/*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语句

15、前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。,C语言编程规范,2 注释,2-1：避免在一行代码或表达式的中间插入注释。2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。,C语言编程规范,2 注释,2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束。2-5：注释格式尽量统一，建议使用“/*/”。2-6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，

16、建议多使用中文，除非能用非常流利准确的英文表达。,C语言编程规范,3 标识符命名,C语言编程规范,3 标识符命名,3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。3-2：命名中若使用特殊约定或缩写，则要有注释说明。说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特殊的缩写，进行必要的注释说明 3-3：自己特有的命名风格，要自始至终保持一致，不可来回变化。,C语言编程规范,3 标识符命名,3-4：对于变量命名，禁止取单个字符（如i、j、k.），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是

17、允许的。3-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一.,C语言编程规范,3 标识符命名,3-1：除非必要，不要用数字或较奇怪的字符来定义标识符。3-2：在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防止编译、链接时产生冲突。说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。3-3：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。,C语言编程规范,3 标识符命名,说明：下面是一些在软件中常用的反义词组。add/remove begin/end create/destroy inser

18、t/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_name);,C语言编程规范,3

19、 标识符命名,3-4：除了编译开关/头文件等特殊应用，应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。,C语言编程规范,4 可读性,C语言编程规范,4 可读性,4-1：注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。4-2：避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。4-3：源程序中关系较为紧密的代码应尽可能相邻。,若按如下形式书写，可能更清晰一些。rect.length=10;rect.width=5;char_poi=str;,说明：便于程序阅读和查找。示例：以下

20、代码布局不太合理。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：明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。说明：明确过程操作变量的关系后，将有利于程序的

21、进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。,C语言编程规范,5 变量、结构,5-4：当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。5-5：防止局部变量与公共变量同名。5-6：严禁使用未经初始化的变量作为指针。说明：特别是在C/C+中引用未经赋值的指针，经常会引起系统崩溃。5-1：构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共变量，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。说明：降低公共变量耦合度。,C语言编程规范,5 变量、结构,5-2：使用严格形式定义的、可移植的数据类型，尽量不要使用与

22、具体硬件或软件环境关系密切的变量。说明：使用标准的数据类型，有利于程序的移植。示例：如下例子（在DOS下BC3.1环境中），在移植时可能产生问题。void main()register int index;/寄存器变量 _AX=0 x4000;/_AX是BC3.1提供的寄存器“伪变量”./program code,C语言编程规范,5 变量、结构,5-3：结构的功能要单一，是针对一种事务的抽象。说明：结构中的各元素应代表同一事务的不同侧面，而不应把描述没有关系或关系很弱的不同事务的元素放到同一结构中。5-4：不要设计面面俱到、非常灵活的数据结构。说明：面面俱到、灵活的数据结构反而容易引起误解和操

23、作困难。5-5：不同结构间的关系不要过于复杂。说明：若两个结构间关系较复杂、密切，那么应合为一个结构。5-6：结构中元素的个数应适中。若结构中元素个数过多可考虑依据某种原则把元素组成不同的子结构，以减少原结构中元素的个数。说明：增加结构的可理解性、可操作性和可维护性。,C语言编程规范,5 变量、结构,5-7：仔细设计结构中元素的布局与排列顺序，使结构容易理解、节省占用空间，并减少引起误用现象。5-8：结构的设计要尽量考虑向前兼容和以后的版本升级，并为某些未来可能的应用保留余地（如预留一些空间等）。5-9：留心具体语言及编译器处理不同数据类型的原则及有关细节。说明：如在C语言中，static局部

24、变量将在内存“数据区”中生成，而非static局部变量将在“堆栈”中生成。这些细节对程序质量的保证非常重要。5-10：编程时，要注意数据类型的强制转换。说明：当进行数据类型强制转换时，其数据的意义、转换后的取值等都有可能发生变化，而这些细节若考虑不周，就很有可能留下隐患。,C语言编程规范,5 变量、结构,5-11：对编译系统默认的数据类型转换，也要有充分的认识。5-12：尽量减少没有必要的数据类型默认转换与强制转换。5-13：合理地设计数据并使用自定义数据类型，避免数据间进行不必要的类型转换。5-14：对自定义数据类型进行恰当命名，使它成为自描述性的，以提高代码可读性。注意其命名方式在同一产品

25、中的统一。,C语言编程规范,6 函数、过程,C语言编程规范,6 函数、过程,6-1：对所调用函数的错误返回码要仔细、全面地处理。6-2：明确函数功能，精确（而不是近似）地实现函数设计。6-3：编写可重入函数时，应注意局部变量的使用（如编写C/C+语言的可重入函数时，应使用auto即缺省态局部变量或寄存器变量）。说明：编写C/C+语言的可重入函数时，不应使用static局部变量，否则必须经过特殊处理，才能使函数具有可重入性。6-4：编写可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段对其加以保护。说明：若对所使用的全局变量不加以保护，则此函数就不具有可重入性，即当多个进

26、程调用此函数时，很有可能使有关全局变量变为不可知状态。,C语言编程规范,6 函数、过程,示例：假设Exam是int型全局变量，函数Squre_Exam返回Exam平方值。那么如下函数不具有可重入性。unsigned int example(int para)unsigned int temp;Exam=para;/（*）temp=Square_Exam();return temp;此函数若被多个进程调用的话，其结果可能是未知的，因为当（*）语句刚执行完后，另外一个使用本函数的进程可能正好被激活，那么当新激活的进程执行到此函数时，将使Exam赋与另一个不同的para值，所以当控制重新回到“tem

27、p=Square_Exam()”后，计算出的temp很可能不是预想中的结果。,C语言编程规范,6 函数、过程,此函数应如下改进。unsigned int example(int para)unsigned int temp;申请信号量操作/若申请不到“信号量”，说明另外的进程正处于 Exam=para;/给Exam赋值并计算其平方过程中（即正在使用此 temp=Square_Exam();/信号），本进程必须等待其释放信号后，才可继 释放信号量操作/续执行。若申请到信号，则可继续执行，但其/它进程必须等待本进程释放信号量后，才能再使/用本信号。return temp;,C语言编程规范,6 函数

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

29、语言编程规范,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 num;co

30、unt+)sum_temp+=datacount;*sum=sum_temp;,C语言编程规范,6 函数、过程,6-2：函数的规模尽量限制在200行以内。说明：不包括注释和空格行。6-3：一个函数仅完成一件功能。6-4：为简单功能编写函数。6-5：不要设计多用途面面俱到的函数。说明：多功能集于一身的函数，很可能使函数的理解、测试、维护等变得困难。6-6：函数的功能应该是可以预测的，也就是只要输入数据相同就应产生同样的输出。,C语言编程规范,6 函数、过程,./程序代码proc Print_Msg/过程（函数）Print_Msg./程序代码 jmp LABEL./程序代码endpproc Inp

31、ut_Msg/过程（函数）Input_Msg./程序代码LABEL:./程序代码endp,6-7：尽量不要编写依赖于其他函数内部实现的函数。说明：此条为函数独立性的基本要求。由于目前大部分高级语言都是结构化的，所以通过具体语言的语法要求与编译器功能，基本就可以防止这种情况发生。但在汇编语言中，由于其灵活性，很可能使函数出现这种情况。,示例：左边是在DOS下TASM的汇编程序例子。过程Print_Msg的实现依赖于Input_Msg的具体实现，这种程序是非结构化的，难以维护、修改。,C语言编程规范,6 函数、过程,6-8：避免设计多参数函数，不使用的参数从接口中去掉。说明：目的减少函数间接口的复

32、杂度。6-9：非调度函数应减少或防止控制参数，尽量只使用数据参数。说明：本建议目的是防止函数间的控制耦合。调度函数是指根据输入的消息类型或控制命令，来启动相应的功能实体（即函数或过程），而本身并不完成具体功能。控制参数是指改变函数功能行为的参数，即函数要根据此参数来决定具体怎样工作。非调度函数的控制参数增加了函数间的控制耦合，很可能使函数间的耦合度增大，并使函数的功能不唯一。,C语言编程规范,6 函数、过程,6-10：检查函数所有参数输入的有效性。6-11：检查函数所有非参数输入的有效性，如数据文件、公共变量等。说明：函数的输入主要有两种：一种是参数输入；另一种是全局变量、数据文件的输入，即非

33、参数输入。函数在使用输入之前，应进行必要的检查。6-12：函数名应准确描述函数的功能。,C语言编程规范,6 函数、过程,6-13：使用动宾词组为执行某操作的函数命名。如果是OOP方法，可以只有动词（名词是对象本身）。示例：参照如下方式命名函数。void print_record(unsigned int rec_ind);int input_record(void);unsigned char get_current_color(void);建议6-14：避免使用无意义或含义不清的动词为函数命名。建议6-15：函数的返回值要清楚、明了，让使用者不容易忽视错误情况6-16：除非必要，最好不要把与

34、函数返回值类型不同的变量，以编译系统默认的转换方式或强制的转换方式作为返回值返回。6-17：让函数在调用点显得易懂、容易理解。,C语言编程规范,6 函数、过程,6-18：在调用函数填写参数时，应尽量减少没有必要的默认数据类型转换或强制数据类型转换。说明：因为数据类型转换或多或少存在危险。6-19：避免函数中不必要语句，防止程序中的垃圾代码。说明：程序中的垃圾代码不仅占用额外的空间，而且还常常影响程序的功能与性能，很可能给程序的测试、维护等造成不必要的麻烦。6-20：防止把没有关联的语句放到一个函数中。说明：防止函数或过程内出现随机内聚。随机内聚是指将没有关联或关联很弱的语句放到同一个函数或过程

35、中。随机内聚给函数或过程的维护、测试及以后的升级等造成了不便，同时也使函数或过程的功能不明确。,C语言编程规范,6 函数、过程,6-21：如果多段代码重复做同一件事情，那么在函数的划分上可能存在问题。说明：若此段代码各语句之间有实质性关联并且是完成同一件功能的，那么可考虑把此段代码构造成一个新的函数。6-22：功能不明确较小的函数，特别是仅有一个上级函数调用它时，应考虑把它合并到上级函数中，而不必单独存在。6-23：设计高扇入、合理扇出（小于7）的函数。说明：(扇出是指一个函数直接调用（控制）其它函数的数目，而扇入是指有多少上级函数调用它).扇出过大，表明函数过分复杂，需要控制和协调过多的下级

36、函数；而扇出过小，如总是1，表明函数的调用层次可能过多，这样不利程序阅读和函数结构的分析，并且程序运行时会对系统资源如堆栈空间等造成压力。函数较合理的扇出（调度函数除外）通常是3-5。,C语言编程规范,6 函数、过程,6-24：减少函数本身或函数间的递归调用。说明：递归调用特别是函数间的递归调用（如A-B-C-A），影响程序的可理解性；递归调用一般都占用较多的系统资源（如栈空间）；递归调用对程序的测试有一定影响。故除非为某些算法或功能的实现方便，应减少没必要的递归调用。6-25：仔细分析模块的功能及性能需求，并进一步细分，同时若有必要画出有关数据流图，据此来进行模块的函数划分与组织。说明：函数

37、的划分与组织是模块的实现过程中很关键的步骤，如何划分出合理的函数结构，关系到模块的最终效率和可维护性、可测性等。根据模块的功能图或数据流图映射出函数结构是常用方法之一。,C语言编程规范,6 函数、过程,6-26：改进模块中函数的结构，降低函数间的耦合度，并提高函数的独立性以及代码可读性、效率和可维护性。优化函数结构时，要遵守以下原则：（1）不能影响模块功能的实现。（2）仔细考查模块或函数出错处理及模块的性能要求并进行完善。（3）通过分解或合并函数来改进软件结构。（4）考查函数的规模，过大的要进行分解。（5）降低函数间接口的复杂度。（6）不同层次的函数调用要有较合理的扇入、扇出。（7）函数功能应

38、可预测。（8）提高函数内聚。（单一功能的函数内聚最高）说明：对初步划分后的函数结构应进行改进、优化，使之更为合理。,C语言编程规范,6 函数、过程,6-27：在多任务操作系统的环境下编程，要注意函数可重入性的构造。说明：可重入性是指函数可以被多个任务进程调用。在多任务操作系统中，函数是否具有可重入性是非常重要的，因为这是多个进程可以共用此函数的必要条件。另外，编译器是否提供可重入函数库，与它所服务的操作系统有关，只有操作系统是多任务时，编译器才有可能提供可重入函数库。(如DOS下BC和MSC等就不具备可重入函数库，因为DOS是单用户单任务操作系统)。6-28：避免使用BOOL参数。(C语言中没

39、有BOOL)说明：原因有二，其一是BOOL参数值无意义，TURE/FALSE的含义是非常模糊的，在调用时很难知道该参数到底传达的是什么意思；其二是BOOL参数值不利于扩充。还有NULL也是一个无意义的单词。,C语言编程规范,6 函数、过程,6-29：对于提供了返回值的函数，在引用时最好使用其返回值。6-30：当一个过程（函数）中对较长变量（一般是结构的成员）有较多引用时，可以用一个意义相当的宏代替。说明：这样可以增加编程效率和程序的可读性。示例：在某过程中较多引用TheReceiveBufferFirstSocket.byDataPtr，则可以通过以下宏定义来代替：#define pSOCKD

40、ATA TheReceiveBufferFirstScoket.byDataPtr,C语言编程规范,7 可测性,C语言编程规范,7 可测性,7-1：在同一项目组或产品组内，要有一套统一的为集成测试与系统联调准备的调测开关及相应打印函数，并且要有详细的说明。说明：本规则是针对项目组或产品组的。7-2：在同一项目组或产品组内，调测打印出的信息串的格式要有统一的形式。信息串中至少要有所在模块名（或源文件名）及行号。说明：统一的调测信息格式便于集成测试。7-3：编程的同时要为单元测试选择恰当的测试点，并仔细构造测试代码、测试用例，同时给出明确的注释说明。测试代码部分应作为（模块中的）一个子模块，以方便

41、测试代码在模块中的安装与拆卸（通过调测开关）。说明：为单元测试而准备。,C语言编程规范,7 可测性,7-4：在进行集成测试/系统联调之前，要构造好测试环境、测试项目及测试用例，同时仔细分析并优化测试用例，以提高测试效率。说明：好的测试用例应尽可能模拟出程序所遇到的边界值、各种复杂环境及一些极端情况等。7-5：使用断言来发现软件问题，提高代码可测性。说明：断言是对某种假设条件进行检查（可理解为若条件成立则无动作，否则应报告），它可以快速发现并定位软件问题，同时对系统错误进行自动报警。断言可以对在系统中隐藏很深，用其它手段极难发现的问题进行定位，从而缩短软件问题定位时间，提高系统的可测性。实际应用

42、时，可根据具体情况灵活地设计断言。,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(_F

43、ILE_,_LINE_)#else/若不使用断言测试#define EXAM_ASSERT(condition)NULL#endif/*end of ASSERT*/,C语言编程规范,7 可测性,7-6：用断言来检查程序正常运行时不应发生但在调测时有可能发生的非法情况。7-7：不能用断言来检查最终产品肯定会出现且必须处理的错误情况。说明：断言是用来处理不应该发生的错误情况的，对于可能会发生的且必须处理的情况要写防错程序，而不是断言。如某模块收到其它模块或链路上的消息后，要对消息的合理性进行检查，此过程为正常的错误检查，不能用断言来实现。7-8：对较复杂的断言加上明确的注释。说明：为复杂的断言加

44、注释，可澄清断言含义并减少不必要的误用。,C语言编程规范,7 可测性,7-9：用断言确认函数的参数。示例：假设某函数参数中有一个指针，那么使用指针前可对它检查，如下。int exam_fun(unsigned char*str)EXAM_ASSERT(str!=NULL);/用断言检查“假设指针不为空”这个条件./other program code,C语言编程规范,7 可测性,7-10：用断言保证没有定义的特性或功能不被使用。示例：假设某通信模块在设计时，准备提供“无连接”和“连接”这两种业务。但当前的版本中仅实现了“无连接”业务，且在此版本的正式发行版中，用户（上层模块）不应产生“连接”业

45、务的请求，那么在测试时可用断言检查用户是否使用“连接”业务。如下。#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

46、code,C语言编程规范,7 可测性,7-11：用断言对程序开发环境（OS/Compiler/Hardware）的假设进行检查。说明：程序运行时所需的软硬件环境及配置要求，不能用断言来检查，而必须由一段专门代码处理。用断言仅可对程序开发环境中的假设及所配置的某版本软硬件是否具有某种功能的假设进行检查。如某网卡是否在系统运行环境中配置了，应由程序中正式代码来检查；而此网卡是否具有某设想的功能，则可由断言来检查。对编译器提供的功能及特性假设可用断言检查，原因是软件最终产品（即运行代码或机器码）与编译器已没有任何直接关系，即软件运行过程中（注意不是编译过程中）不会也不应该对编译器的功能提出任何需求。

47、示例：用断言检查编译器的int型数据占用的内存空间是否为2，如下。EXAM_ASSERT(sizeof(int)=2);7-12：正式软件产品中应把断言及其它调测代码去掉（即把有关的调测开关关掉）。说明：加快软件运行速度。,C语言编程规范,7 可测性,7-13：在软件系统中设置与取消有关测试手段，不能对软件实现的功能等产生影响。说明：即有测试代码的软件和关掉测试代码的软件，在功能行为上应一致。7-14：用调测开关来切换软件的DEBUG版和正式版，而不要同时存在正式版本和DEBUG版本的不同源文件，以减少维护的难度。7-15：软件的DEBUG版本和发行版本应该统一维护，不允许分家，并且要时刻注意

48、保证两个版本在实现功能上的一致性。,C语言编程规范,7 可测性,7-1：在编写代码之前，应预先设计好程序调试与测试的方法和手段，并设计好各种调测开关及相应测试代码如打印函数等。说明：程序的调试与测试是软件生存周期中很重要的一个阶段，如何对软件进行较全面、高率的测试并尽可能地找出软件中的错误就成为很关键的问题。因此在编写源代码之前，除了要有一套比较完善的测试计划外，还应设计出一系列代码测试手段，为单元测试、集成测试及系统联调提供方便。7-2：调测开关应分为不同级别和类型。说明：调测开关的设置及分类应从以下几方面考虑：针对模块或系统某部分代码的调测；针对模块或系统某功能的调测；出于某种其它目的，如

49、对性能、容量等的测试。这样做便于软件功能的调测，并且便于模块的单元测试、系统联调等。,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

50、,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 ch