编程规范和范例 (2).pdf

《编程规范和范例 (2).pdf》由会员分享，可在线阅读，更多相关《编程规范和范例 (2).pdf（59页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、目目目目 录录录录 1 排版 62 注释 113 标识符命名 184 可读性 205 变量、结构 226 函数、过程 287 可测性 368 程序效率 409 质量保证 4410 代码编辑、编译、审查 5011 代码测试、维护 5212 宏 53 软件编程规范总则 1 排版 仅供内部使用 2 1 排版排版排版排版 1-1：程序块要采用缩进风格编写程序块要采用缩进风格编写程序块要采用缩进风格编写程序块要采用缩进风格编写，缩进的空格数为缩进的空格数为缩进的空格数为缩进的空格数为4个个个个 说明：对于由开发工具自动生成的代码可以有不一致 1-2：相对独立的程序块之间相对独立的程序块之间相对独立的程序

2、块之间相对独立的程序块之间变量说明之后必须加空行变量说明之后必须加空行变量说明之后必须加空行变量说明之后必须加空行 示例：如下例子不符合规范 if(!valid_ni(ni)./program code repssn_ind=ssn_dataindex.repssn_index;repssn_ni =ssn_dataindex.ni;应如下书写 if(!valid_ni(ni)./program code repssn_ind=ssn_dataindex.repssn_index;repssn_ni =ssn_dataindex.ni;1-3：较长的语句较长的语句较长的语句较长的语句（80字符

3、字符字符字符）要分成多行书写要分成多行书写要分成多行书写要分成多行书写，长表达式要在低优先级操作符处划分新行长表达式要在低优先级操作符处划分新行长表达式要在低优先级操作符处划分新行长表达式要在低优先级操作符处划分新行，操作符放在新行之首操作符放在新行之首操作符放在新行之首操作符放在新行之首，划分出的新行要进行适当的缩进划分出的新行要进行适当的缩进划分出的新行要进行适当的缩进划分出的新行要进行适当的缩进，使排版整齐使排版整齐使排版整齐使排版整齐，语句可读语句可读语句可读语句可读 示例：perm_count_msg.head.len=NO7_TO_STAT_PERM_COUNT_LEN +STAT

4、_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)软件编程规范总则 1 排版 仅供内部使用 3&(n7stat_stat_item_valid(stat_item

5、)&(act_task_tabletaskno.result_data!=0);软件编程规范总则 1 排版 仅供内部使用 4 1-4：循环循环循环循环判断等语句中若有较长的表达式或语句判断等语句中若有较长的表达式或语句判断等语句中若有较长的表达式或语句判断等语句中若有较长的表达式或语句，则要进行适应的划分则要进行适应的划分则要进行适应的划分则要进行适应的划分，长表达式要在低长表达式要在低长表达式要在低长表达式要在低优先级操作符处划分新行优先级操作符处划分新行优先级操作符处划分新行优先级操作符处划分新行，操作符放在新行之首操作符放在新行之首操作符放在新行之首操作符放在新行之首 示例：if(tas

6、kno max_act_task_number)&(n7stat_stat_item_valid(stat_item)./program code for(i=0,j=0;(i BufferKeywordword_index.word_length)&(j NewKeyword.word_length);i+,j+)./program code for(i=0,j=0;(i first_word_length)&(j），），），），后不应加空后不应加空后不应加空后不应加空格格格格 说明：采用这种松散方式编写代码的目的是使代码更加清晰 由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句

7、中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在 C/C+语言中括号已经是最清晰的标志了 在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格给操作符留空格时不要连续留两个以上空格 示例：(1)逗号分号只在后面加空格 int a,b,c;软件编程规范总则 1 排版 仅供内部使用 7 (2)比较操作符,赋值操作符=+=，算术操作符+%，逻辑操作符&，位域操作符=MAX_TIME_VALUE)a=b+c;a*=2;a=b 2;(3)!+-&（地址运算符）等单目操作符前后不加空格*p=a;/内容操作*与内容之

8、间 flag=!isEmpty;/非操作!与内容之间 p=&mem;/地址操作&与内容之间 i+;/+,-与内容之间 (4)-.前后不加空格 p-id=pid;/-指针前后不加空格 (5)ifforwhileswitch 等与后面的括号间应加空格，使 if 等关键字更为突出明显 if(a=b&c d)1-1：一行程序以小于一行程序以小于一行程序以小于一行程序以小于80字符为宜字符为宜字符为宜字符为宜，不要写得过长不要写得过长不要写得过长不要写得过长 软件编程规范总则 2 注释 仅供内部使用 8 2 注释注释注释注释 2-1：一般情况下一般情况下一般情况下一般情况下，源程序有效注释量必须在源程序

9、有效注释量必须在源程序有效注释量必须在源程序有效注释量必须在20以上以上以上以上 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确易懂简洁 2-2：说明性文件说明性文件说明性文件说明性文件（如头文件如头文件如头文件如头文件.h文件文件文件文件.inc文件文件文件文件.def文件文件文件文件编译说明文件编译说明文件编译说明文件编译说明文件.cfg等等等等）头部应头部应头部应头部应进行注释进行注释进行注释进行注释，注释必须列出注释必须列出注释必须列出注释必须列出：版权说明版权说明版权说明版权说明版本号版本号版本号版本号生成日期生成日期生成日期生

10、成日期作者作者作者作者内容内容内容内容功能功能功能功能与其它文件的与其它文件的与其它文件的与其它文件的关系关系关系关系修改日志等修改日志等修改日志等修改日志等，头文件的注释中还应有函数功能简要说明头文件的注释中还应有函数功能简要说明头文件的注释中还应有函数功能简要说明头文件的注释中还应有函数功能简要说明 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内/*Copyright(C),1988-1999,Huawei Tech.Co.,Ltd.File name:/文件名 Author:Version:Date:/作者版本及完成日期 Description:/

11、用于详细说明此程序文件完成的主要功能，与其他模块 /或函数的接口，输出值取值范围含义及参数间的控 /制顺序独立或依赖等关系 Others:/其它内容的说明 Function List:/主要函数列表，每条记录应包括函数名及功能简要说明 1.History:/修改历史记录列表，每条修改记录应包括修改日期修改 /者及修改内容简述 1.Date:Author:Modification:2.*/2-3：源源源源文件头部应进行注释文件头部应进行注释文件头部应进行注释文件头部应进行注释，列出列出列出列出：版权说明版权说明版权说明版权说明版本号版本号版本号版本号生成日期生成日期生成日期生成日期作者作者作者作

12、者模块目的模块目的模块目的模块目的/功能功能功能功能主要函数及其功能主要函数及其功能主要函数及其功能主要函数及其功能修改日志等修改日志等修改日志等修改日志等 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内 软件编程规范总则 2 注释 仅供内部使用 9/*Copyright(C),1988-1999,Huawei Tech.Co.,Ltd.FileName:test.cpp Author:Version:Date:Description:/模块描述 Version:/版本信息 Function List:/主要函数及其功能 1.-History:/历史修改

13、记录 David 96/10/12 1.0 build this moudle */说明：Description 一项描述本文件的内容功能内部各部分之间的关系及本文件与其它文件关系等History 是修改历史记录列表，每条修改记录应包括修改日期修改者及修改内容简述 2-4：函数头部应进行注释函数头部应进行注释函数头部应进行注释函数头部应进行注释，列出列出列出列出：函数的目的函数的目的函数的目的函数的目的/功能功能功能功能输入参数输入参数输入参数输入参数输出参数输出参数输出参数输出参数返回值返回值返回值返回值调用调用调用调用关系关系关系关系（函数函数函数函数表表表表）等等等等 示例：下面这段函数

14、的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内/*Function:/函数名称 Description:/函数功能性能等的描述 Calls:/被本函数调用的函数清单 Called By:/调用本函数的函数清单 Table Accessed:/被访问的表（此项仅对于牵扯到数据库操作的程序）Table Updated:/被修改的表（此项仅对于牵扯到数据库操作的程序）Input:/输入参数说明，包括每个参数的作 /用取值说明及参数间关系 Output:/对输出参数的说明 Return:/函数返回值的说明 Others:/其它说明*/软件编程规范总则 2 注释 仅供内部使用 10 2

15、-5：边写代码边注释边写代码边注释边写代码边注释边写代码边注释，修改代码同时修改相应的注释修改代码同时修改相应的注释修改代码同时修改相应的注释修改代码同时修改相应的注释，以保证注释与代码的一致性以保证注释与代码的一致性以保证注释与代码的一致性以保证注释与代码的一致性不再有不再有不再有不再有用用用用的注释要删除的注释要删除的注释要删除的注释要删除 2-6：注释的内容要清楚注释的内容要清楚注释的内容要清楚注释的内容要清楚明了明了明了明了，含义准确含义准确含义准确含义准确，防止注释二义性防止注释二义性防止注释二义性防止注释二义性 说明：错误的注释不但无益反而有害 规则规则规则规则2-7：避免在注释中

16、使用缩写避免在注释中使用缩写避免在注释中使用缩写避免在注释中使用缩写，特别是非常用缩写特别是非常用缩写特别是非常用缩写特别是非常用缩写 说明：在使用缩写时或之前，应对缩写进行必要的说明 2-8：注释应与其描述的代码相近注释应与其描述的代码相近注释应与其描述的代码相近注释应与其描述的代码相近，对代码的注释应放在其上方或右方对代码的注释应放在其上方或右方对代码的注释应放在其上方或右方对代码的注释应放在其上方或右方（对单条语句的注释对单条语句的注释对单条语句的注释对单条语句的注释）相邻位置相邻位置相邻位置相邻位置，不可放在下面不可放在下面不可放在下面不可放在下面，如放于上方则需与其上面的代码用空行隔

17、开如放于上方则需与其上面的代码用空行隔开如放于上方则需与其上面的代码用空行隔开如放于上方则需与其上面的代码用空行隔开 示例：如下例子不符合规范 例 1：/*get replicate sub system index and net indicator*/repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;例 2：repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;/*get replicate sub system index and n

18、et indicator*/应如下书写/*get replicate sub system index and net indicator*/repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;2-9：对于所有有物理含义的变量对于所有有物理含义的变量对于所有有物理含义的变量对于所有有物理含义的变量常量常量常量常量，如果其命名不是充分自注释的如果其命名不是充分自注释的如果其命名不是充分自注释的如果其命名不是充分自注释的，在声明时都必须加在声明时都必须加在声明时都必须加在声明时都必须加以注释以注释以注释以注释，说明其物理

19、含义说明其物理含义说明其物理含义说明其物理含义变量变量变量变量常量常量常量常量宏的注释应放在其上方相邻位置或右方宏的注释应放在其上方相邻位置或右方宏的注释应放在其上方相邻位置或右方宏的注释应放在其上方相邻位置或右方 示例：/*active statistic task number*/#define MAX_ACT_TASK_NUMBER 1000 软件编程规范总则 2 注释 仅供内部使用 11#define MAX_ACT_TASK_NUMBER 1000/*active statistic task number*/2-10：数据结构声明数据结构声明数据结构声明数据结构声明(包括数组包括数

20、组包括数组包括数组结构结构结构结构类类类类枚举等枚举等枚举等枚举等)，如果其命名不是充分自注释的如果其命名不是充分自注释的如果其命名不是充分自注释的如果其命名不是充分自注释的，必须必须必须必须加以注释加以注释加以注释加以注释对数据结构的注释应放在其上方相邻位置对数据结构的注释应放在其上方相邻位置对数据结构的注释应放在其上方相邻位置对数据结构的注释应放在其上方相邻位置，不可放在下面不可放在下面不可放在下面不可放在下面；对结构中的每个域的注对结构中的每个域的注对结构中的每个域的注对结构中的每个域的注释放在此域的右方释放在此域的右方释放在此域的右方释放在此域的右方 示例：可按如下形式说明枚举/数据/

21、联合结构/*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*/;2-11：全局变量要有较详

22、细的注释全局变量要有较详细的注释全局变量要有较详细的注释全局变量要有较详细的注释，包括对其功能包括对其功能包括对其功能包括对其功能取值范围取值范围取值范围取值范围哪些函数或过程存取它以及哪些函数或过程存取它以及哪些函数或过程存取它以及哪些函数或过程存取它以及存取时注意事项等的说明存取时注意事项等的说明存取时注意事项等的说明存取时注意事项等的说明 示例：/*The ErrorCode when SCCP translate*/*Global Title failure,as follows*/变量作用含义/*0 SUCCESS 1 GT Table error*/*2 GT error Othe

23、rs no use */变量取值范围/*only function SCCPTranslate()in*/*this modual can modify it,and other*/*module can visit it through call*/*the function GetGTTransErrorCode()*/使用方法 BYTE g_GTTranErrorCode;2-12：注释与所描述内容进行同样的缩排注释与所描述内容进行同样的缩排注释与所描述内容进行同样的缩排注释与所描述内容进行同样的缩排 说明：可使程序排版整齐，并方便注释的阅读与理解 示例：如下例子，排版不整齐，阅读稍感不

24、方便 void example_fun(void)/*code one comments*/CodeBlock One 软件编程规范总则 2 注释 仅供内部使用 12 /*code two comments*/CodeBlock Two 应改为如下布局 void example_fun(void)/*code one comments*/CodeBlock One /*code two comments*/CodeBlock Two 2-13：将注释与其上面的代码用空行隔开将注释与其上面的代码用空行隔开将注释与其上面的代码用空行隔开将注释与其上面的代码用空行隔开 示例：如下例子，显得代码过于紧

25、凑/*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：对变量的定义和分支语句对变量的定义和分支语句对变量的定义和分支语句对变量的定义和分支语句（条件分支条件分支条件分支条件分支循环语句等循环语句等循环语句等循环语句等）必须编写注释必须编写注释必须编写注释必须编写注释 说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来

26、说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档 2-15：对于对于对于对于switch语句下的语句下的语句下的语句下的case语句语句语句语句，如果因为特殊情况需要处理完一个如果因为特殊情况需要处理完一个如果因为特殊情况需要处理完一个如果因为特殊情况需要处理完一个case后进入下一后进入下一后进入下一后进入下一个个个个case处理处理处理处理，必须在该必须在该必须在该必须在该case语句处理完语句处理完语句处理完语句处理完下一个下一个下一个下一个case语句前加上明确的注释语句前加上明确的注释语句前加上明确的注释语句前加上明确的注释 说明：这样比较清楚程序编写者的意图，有效防止无故遗

27、漏 break 语句 软件编程规范总则 2 注释 仅供内部使用 13 示例（注意斜体加粗部分）：case CMD_UP:ProcessUp();break;case CMD_DOWN:ProcessDown();break;case CMD_FWD:ProcessFwd();if(.).break;else ProcessCFW_B();/now jump into case CMD_A case CMD_A:ProcessA();break;case CMD_B:ProcessB();break;case CMD_C:ProcessC();break;case CMD_D:ProcessD(

28、);软件编程规范总则 2 注释 仅供内部使用 14 break;.2-1：避免在一行代码或表达式的中间插入注释避免在一行代码或表达式的中间插入注释避免在一行代码或表达式的中间插入注释避免在一行代码或表达式的中间插入注释 说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差 2-2：通过对函数或过程通过对函数或过程通过对函数或过程通过对函数或过程变量变量变量变量结构等正确的命名以及合理地组织代码的结构结构等正确的命名以及合理地组织代码的结构结构等正确的命名以及合理地组织代码的结构结构等正确的命名以及合理地组织代码的结构，使代码成为使代码成为使代码成为使代码成为自注释的自注释的

29、自注释的自注释的 说明：清晰准确的函数变量等的命名，可增加代码可读性，并减少不必要的注释 2-3：在代码的功能在代码的功能在代码的功能在代码的功能意图层次上进行注释意图层次上进行注释意图层次上进行注释意图层次上进行注释，提供有用提供有用提供有用提供有用额外的信息额外的信息额外的信息额外的信息 说明：注释的目的是解释代码的目的功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息 示例：如下注释意义不大/*if receive_flag is TRUE*/if(receive_flag)而如下的注释则给出了额外有用的信息 /*if mtp receive a messa

30、ge from links*/if(receive_flag)2-4：在程序块的结束行右方加注释标记在程序块的结束行右方加注释标记在程序块的结束行右方加注释标记在程序块的结束行右方加注释标记，以表明某程序块的结束以表明某程序块的结束以表明某程序块的结束以表明某程序块的结束 说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读 示例：参见如下例子 if(.)/program code while(index MAX_INDEX)/program code /*end of while(index MAX_INDEX)*/指明该条 while 语句结束 /*end of if(

31、.)*/指明是哪条 if 语句结束 软件编程规范总则 2 注释 仅供内部使用 15 2-5：注释格式尽量统一注释格式尽量统一注释格式尽量统一注释格式尽量统一，建议使用建议使用建议使用建议使用/*“*/2-6：注释应考虑程序易读及外观排版的因素注释应考虑程序易读及外观排版的因素注释应考虑程序易读及外观排版的因素注释应考虑程序易读及外观排版的因素，使用的语言若是中使用的语言若是中使用的语言若是中使用的语言若是中英兼有的英兼有的英兼有的英兼有的，建议多使用中建议多使用中建议多使用中建议多使用中文文文文，除非能用非常流利准确的英文表达除非能用非常流利准确的英文表达除非能用非常流利准确的英文表达除非能用

32、非常流利准确的英文表达 说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文 软件编程规范总则 3 标志符命名 仅供内部使用 16 3 标识符命名标识符命名标识符命名标识符命名 3-1：标识符的命名要清晰标识符的命名要清晰标识符的命名要清晰标识符的命名要清晰明了明了明了明了，有明确含义有明确含义有明确含义有明确含义，同时使用完整的单词或大家基本可以理解的同时使用完整的单词或大家基本可以理解的同时使用完整的单词或大家基本可以理解的同时使用完整的单词或大家基本可以理解的缩写缩写缩写缩写，避免使人产生误解避免使人产生误解避免使人产生误解避免使人产生误解 说明：较短的单词

33、可通过去掉元音形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写 示例：如下单词的缩写能够被大家基本认可 temp 可缩写为 tmp ;flag 可缩写为 flg ;statistic 可缩写为 stat;increment 可缩写为 inc ;message 可缩写为 msg ;3-2：命名中若使用特殊约定或缩写命名中若使用特殊约定或缩写命名中若使用特殊约定或缩写命名中若使用特殊约定或缩写，则要有注释说明则要有注释说明则要有注释说明则要有注释说明 说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明 3-3：自己特有的命名风格

34、自己特有的命名风格自己特有的命名风格自己特有的命名风格，要自始至终保持一致要自始至终保持一致要自始至终保持一致要自始至终保持一致，不可来回变化不可来回变化不可来回变化不可来回变化 说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用（即命名规则中没有规定到的地方才可有个人命名风格）3-4：对于变量命名对于变量命名对于变量命名对于变量命名，禁止取单个字符禁止取单个字符禁止取单个字符禁止取单个字符（如如如如ijk.），），），），建议除了要有具体含义外建议除了要有具体含义外建议除了要有具体含义外建议除了要有具体含义外，还能还能还能还能表明其变量类型表明其变量类型表明其变量类型

35、表明其变量类型数据类型等数据类型等数据类型等数据类型等，但但但但ijk作局部循环变量是允许的作局部循环变量是允许的作局部循环变量是允许的作局部循环变量是允许的 说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如 i 写成 j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间 示例：下面所示的局部变量名的定义方法可以借鉴 int liv_Width 其变量名解释如下：l 局部变量（Local）（其它：g 全局变量（Global）.）i 数据类型（Interger）v 变量（Variable）（其它：c 常量（Const）.）Width 变量含义 软件编程规范总则

36、3 标志符命名 仅供内部使用 17 这样可以防止局部变量与全局变量重名 3-5：命名规范必须与所使用的系统风格保持一致命名规范必须与所使用的系统风格保持一致命名规范必须与所使用的系统风格保持一致命名规范必须与所使用的系统风格保持一致，并在同一项目中统一并在同一项目中统一并在同一项目中统一并在同一项目中统一，比如采用比如采用比如采用比如采用UNIX的的的的全小写加下划线的风格或大小写混排的方式全小写加下划线的风格或大小写混排的方式全小写加下划线的风格或大小写混排的方式全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式不要使用大小写与下划线混排的方式不要使用大小写与下划线混排

37、的方式不要使用大小写与下划线混排的方式，用作特殊用作特殊用作特殊用作特殊标识如标识成员变量或全局变量的标识如标识成员变量或全局变量的标识如标识成员变量或全局变量的标识如标识成员变量或全局变量的m_和和和和g_，其后加上大小写混排的方式是允许的其后加上大小写混排的方式是允许的其后加上大小写混排的方式是允许的其后加上大小写混排的方式是允许的 示例：Add_User 不允许，add_userAddUserm_AddUser 允许 3-1：除非必要除非必要除非必要除非必要，不要用数字或较奇怪的字符来定义标识符不要用数字或较奇怪的字符来定义标识符不要用数字或较奇怪的字符来定义标识符不要用数字或较奇怪的字

38、符来定义标识符 示例：如下命名，使人产生疑惑#define _EXAMPLE_0_TEST_#define _EXAMPLE_1_TEST_ void set_sls00(BYTE sls);应改为有意义的单词命名#define _EXAMPLE_UNIT_TEST_#define _EXAMPLE_ASSERT_TEST_ void set_udt_msg_sls(BYTE sls);3-2：在同一软件产品内在同一软件产品内在同一软件产品内在同一软件产品内，应规划好接口部分标识符应规划好接口部分标识符应规划好接口部分标识符应规划好接口部分标识符（变量变量变量变量结构结构结构结构函数及常量函数

39、及常量函数及常量函数及常量）的命名的命名的命名的命名，防防防防止编译止编译止编译止编译链接时产生冲突链接时产生冲突链接时产生冲突链接时产生冲突 说明：对接口部分的标识符应该有更严格限制，防止冲突如可规定接口部分的变量与常量之前加上模块标识等 3-3：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等用正确的反义词组命名具有互斥意义的变量或相反动作的函数等用正确的反义词组命名具有互斥意义的变量或相反动作的函数等用正确的反义词组命名具有互斥意义的变量或相反动作的函数等 说明：下面是一些在软件中常用的反义词组 add/remove begin/end create/destroy insert

40、/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;软件编程规范总则 3 标志符命名 仅供内部使用 18 int max_sum;int add_user(BYTE*user_name);int delet

41、e_user(BYTE*user_name);3-4：除了编译开关除了编译开关除了编译开关除了编译开关/头文件等特殊应用头文件等特殊应用头文件等特殊应用头文件等特殊应用，应避免使用应避免使用应避免使用应避免使用_EXAMPLE_TEST_之类以下划线开始和之类以下划线开始和之类以下划线开始和之类以下划线开始和结尾的定义结尾的定义结尾的定义结尾的定义 软件编程规范总则 4 可读性 仅供内部使用 19 4 可读性可读性可读性可读性 4-1：注意运算符的优先级注意运算符的优先级注意运算符的优先级注意运算符的优先级，并用括号明确表达式的操作顺序并用括号明确表达式的操作顺序并用括号明确表达式的操作顺序并

42、用括号明确表达式的操作顺序，避免使用默认优先级避免使用默认优先级避免使用默认优先级避免使用默认优先级 说明：防止阅读程序时产生误解，防止因默认的优先级与设计思想不符而导致程序出错 示例：下列语句中的表达式 word=(high 8)|low (1)if(a|b)&(a&c)(2)if(a|b)(c&d)(3)如果书写为 high 8|low a|b&a&c a|b c&d 由于 high 8|low=(high 8)|low,a|b&a&c=(a|b)&(a&c)，(1)(2)不会出错，但语句不易理解；a|b c&d=a|（b c）&d，(3)造成了判断条件出错 4-2：避免使用不易理解的数字

43、避免使用不易理解的数字避免使用不易理解的数字避免使用不易理解的数字，用有意义的标识来替代用有意义的标识来替代用有意义的标识来替代用有意义的标识来替代涉及涉及涉及涉及物理状态或者含有物理意义的物理状态或者含有物理意义的物理状态或者含有物理意义的物理状态或者含有物理意义的常量常量常量常量，不应直接使用数字不应直接使用数字不应直接使用数字不应直接使用数字，必须用有意义的枚举或宏来代替必须用有意义的枚举或宏来代替必须用有意义的枚举或宏来代替必须用有意义的枚举或宏来代替 示例：如下的程序可读性差 if(Trunkindex.trunk_state=0)Trunkindex.trunk_state=1;.

44、/program code 应改为如下形式#define TRUNK_IDLE 0#define TRUNK_BUSY 1 if(Trunkindex.trunk_state=TRUNK_IDLE)Trunkindex.trunk_state=TRUNK_BUSY;软件编程规范总则 4 可读性 仅供内部使用 20 ./program code 4-1：源程序中关系较为紧密的代码应尽可能相邻源程序中关系较为紧密的代码应尽可能相邻源程序中关系较为紧密的代码应尽可能相邻源程序中关系较为紧密的代码应尽可能相邻 说明：便于程序阅读和查找 示例：以下代码布局不太合理 rect.length=10;char

45、_poi=str;rect.width=5;若按如下形式书写，可能更清晰一些 rect.length=10;rect.width=5;/矩形的长与宽关系较密切，放在一起 char_poi=str;4-2：不要使用难懂的技巧性很高的语句不要使用难懂的技巧性很高的语句不要使用难懂的技巧性很高的语句不要使用难懂的技巧性很高的语句，除非很有必要时除非很有必要时除非很有必要时除非很有必要时 说明：高技巧语句不等于高效率的程序，实际上程序的效率关键在于算法 示例：如下表达式，考虑不周就可能出问题，也较难理解*stat_poi+=1;*+stat_poi+=1;应分别改为如下*stat_poi+=1;sta

46、t_poi+;/此二语句功能相当于*stat_poi+=1;+stat_poi;*stat_poi+=1;/此二语句功能相当于*+stat_poi+=1;软件编程规范总则 5 变量结构 仅供内部使用 21 5 变量变量变量变量结构结构结构结构 5-1：去掉没必要的公共变量去掉没必要的公共变量去掉没必要的公共变量去掉没必要的公共变量 说明：公共变量是增大模块间耦合的原因之一，故应减少没必要的公共变量以降低模块间的耦合度 5-2：仔细定义并明确公共变量的含义仔细定义并明确公共变量的含义仔细定义并明确公共变量的含义仔细定义并明确公共变量的含义作用作用作用作用取值范围及公共变量间的关系取值范围及公共变

47、量间的关系取值范围及公共变量间的关系取值范围及公共变量间的关系 说明：在对变量声明的同时，应对其含义作用及取值范围进行注释说明，同时若有必要还应说明与其它变量的关系 5-3：明确公共变量与操作此公共变量的函数或过程的关系明确公共变量与操作此公共变量的函数或过程的关系明确公共变量与操作此公共变量的函数或过程的关系明确公共变量与操作此公共变量的函数或过程的关系，如访问如访问如访问如访问修改及创建等修改及创建等修改及创建等修改及创建等 说明：明确过程操作变量的关系后，将有利于程序的进一步优化单元测试系统联调以及代码维护等这种关系的说明可在注释或文档中描述 示例：在源文件中，可按如下注释形式说明 RE

48、LATION System_Init Input_Rec Print_Rec Stat_Score Student Create Modify Access Access Score Create Modify Access Access,Modify 注：RELATION 为操作关系；System_InitInput_RecPrint_RecStat_Score为四个不同的函数；StudentScore 为两个全局变量；Create 表示创建，Modify 表示修改，Access 表示访问 其中，函数 Input_RecStat_Score 都可修改变量 Score，故此变量将引起函数间较大

49、的耦合，并可能增加代码测试维护的难度 5-4：当向公共变量传递数据时当向公共变量传递数据时当向公共变量传递数据时当向公共变量传递数据时，要十分小心要十分小心要十分小心要十分小心，防止赋与不合理的值或越界等现象发生防止赋与不合理的值或越界等现象发生防止赋与不合理的值或越界等现象发生防止赋与不合理的值或越界等现象发生 说明：对公共变量赋值时，若有必要应进行合法性检查，以提高代码的可靠性稳定性 5-5：防止局部变量与公共变量同名防止局部变量与公共变量同名防止局部变量与公共变量同名防止局部变量与公共变量同名 说明：若使用了较好的命名规则，那么此问题可自动消除 5-6：严禁使用未经初始化的变量作为右值严

50、禁使用未经初始化的变量作为右值严禁使用未经初始化的变量作为右值严禁使用未经初始化的变量作为右值 说明：特别是在 C/C+中引用未经赋值的指针，经常会引起系统崩溃 软件编程规范总则 5 变量结构 仅供内部使用 22 5-1：构造仅有一个模块或函数可以修改构造仅有一个模块或函数可以修改构造仅有一个模块或函数可以修改构造仅有一个模块或函数可以修改创建创建创建创建，而其余有关模块或函数只访问的公共变量而其余有关模块或函数只访问的公共变量而其余有关模块或函数只访问的公共变量而其余有关模块或函数只访问的公共变量，防止多个不同模块或函数都可以修改防止多个不同模块或函数都可以修改防止多个不同模块或函数都可以修