编程规范和范例.doc-道客多多_道客多多docduoduo.com

资源描述

1、华为C语言编程规范目录1 排版 62 注释 113 标识符命名 184 可读性 205 变量、结构 226 函数、过程 287 可测性 368 程序效率 409 质量保证 4410 代码编辑、编译、审查 5011 代码测试、维护 5212 宏 53软件编程规范总则 1 排版仅供内部使用 31 排版1-1：程序块要采用缩进风格编写，缩进的空格数为4 个。说明：对于由开发工具自动生成的代码可以有不一致。1-2：相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if (!valid_ni(ni). / program coderepssn_ind = ssn_datainde

2、x.repssn_index;repssn_ni = ssn_dataindex.ni;应如下书写if (!valid_ni(ni). / program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;1-3：较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_

3、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 ），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空

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

5、!“与内容之间p = / 地址操作“ / “+“,“-“与内容之间(4)“-“、“.“ 前后不加空格。p-id = pid; / “-“指针前后不加空格(5) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显。if (a = b repssn_ni = ssn_dataindex.ni;例 2：repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;/* get replicate sub system index and net indicator */应如下书

6、写/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例：/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000软件编程规范总则 2 注释仅供内部使用 12#define

7、 MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */2-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。示例：可按如下形式说明枚举/数据/ 联合结构。/* sccp interface with sccp user primitive message name */enum SCCP_USER_PRIMITIVEN_UNITDATA_IND, /* sccp notify sccp user u

8、nit 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：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。示例：/* The ErrorCode when SCCP translate */* Global Title failure, as follows

9、 */ / 变量作用、含义/* 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 GetGTTransErrorCode() */ / 使用方法BYTE g_GTTranErrorCode; 2-12：注释与所描述内容进行同样的缩排。说明：可使程序排版整

10、齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍感不方便。void example_fun( void )软件编程规范总则 2 注释仅供内部使用 13/* code one comments */CodeBlock One/* code two comments */CodeBlock Two应改为如下布局。void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two2-13：将注释与其上面的代码用空行隔开。示例：如下例子，显得代码过于紧凑。/* c

11、ode one comments */program code one/* code two comments */program code two应如下书写/* code one comments */program code one/* code two comments */program code two2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。软件编程规范总则 2 注释仅供内部使用 142-15：对于 switch语句下的 case语句，

12、如果因为特殊情况需要处理完一个case后进入下一个case 处理，必须在该 case语句处理完、下一个case语句前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏 break 语句。示例（注意斜体加粗部分）：case CMD_UP: ProcessUp(); break;case CMD_DOWN: ProcessDown(); break;case CMD_FWD: ProcessFwd(); if (.).break;elseProcessCFW_B(); / now jump into case CMD_Acase CMD_A: ProcessA(); break;

13、case CMD_B: ProcessB(); break;case CMD_C: ProcessC(); 软件编程规范总则 2 注释仅供内部使用 15break;case CMD_D: ProcessD(); break;.2-1：避免在一行代码或表达式的中间插入注释。说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。说明：注释的目的是解释

14、代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/* if receive_flag is TRUE */if (receive_flag)而如下的注释则给出了额外有用的信息。 /* if mtp receive a message from links */if (receive_flag)2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束。说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。if (.)/ program codewhile (index MAX_IND

15、EX)/ program code /* end of while (index MAX_INDEX) */ / 指明该条 while 语句结软件编程规范总则 2 注释仅供内部使用 16束 /* end of if (.)*/ / 指明是哪条 if 语句结束2-5：注释格式尽量统一，建议使用 “/* */”。2-6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。软件编程规范总则 3 标志符命名仅供内部使用 173 标识符命名3-1：标识符的命名要

16、清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。示例：如下单词的缩写能够被大家基本认可。temp 可缩写为 tmp ;flag 可缩写为 flg ;statistic 可缩写为 stat ;increment 可缩写为 inc ;message 可缩写为 msg ;3-2：命名中若使用特殊约定或缩写，则要有注释说明。说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。3-3：自己特有的命名风格，要自始至终

17、保持一致，不可来回变化。说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即命名规则中没有规定到的地方才可有个人命名风格）。3-4：对于变量命名，禁止取单个字符（如i 、j、k.），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j 、k作局部循环变量是允许的。说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如 i 写成 j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。示例：下面所示的局部变量名的定义方法可以借鉴。int liv_Width其变量名解释如下：l 局部变量（Local）（其它：g 全局变量（Gl

18、obal）. ）i 数据类型（Interger）v 变量（Variable）（其它：c 常量（Const）. ）Width 变量含义软件编程规范总则 3 标志符命名仅供内部使用 18这样可以防止局部变量与全局变量重名。3-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用作特殊标识如标识成员变量或全局变量的m_和g_ ，其后加上大小写混排的方式是允许的。示例： Add_User 不允许， add_user、AddUser 、m_AddUser 允许。 3-1：除非必要，不要用数字或较奇

19、怪的字符来定义标识符。示例：如下命名，使人产生疑惑。#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：在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防止编译、链接时产生冲突。说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上“

20、模块”标识等。3-3：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。说明：下面是一些在软件中常用的反义词组。add / remove begin / end create / 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 / rece

21、ive source / destinationcut / paste up / down示例：int min_sum;软件编程规范总则 3 标志符命名仅供内部使用 19int max_sum;int add_user( BYTE *user_name );int delete_user( BYTE *user_name );3-4：除了编译开关 /头文件等特殊应用，应避免使用 _EXAMPLE_TEST_之类以下划线开始和结尾的定义。软件编程规范总则 4 可读性仅供内部使用 204 可读性4-1：注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。说明：防止阅读程序时产生误

22、解，防止因默认的优先级与设计思想不符而导致程序出错。示例：下列语句中的表达式word = (high 8) | low (1)if (a | b) . / program code应改为如下形式。#define TRUNK_IDLE 0#define TRUNK_BUSY 1if (Trunkindex.trunk_state = TRUNK_IDLE)软件编程规范总则 4 可读性仅供内部使用 21Trunkindex.trunk_state = TRUNK_BUSY;. / program code4-1：源程序中关系较为紧密的代码应尽可能相邻。说明：便于程序阅读和查找。示例：以下代码布局不

23、太合理。rect.length = 10;char_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;stat_poi+; / 此二语句功能

24、相当于“ * stat_poi + += 1; ”+ stat_poi;*stat_poi += 1; / 此二语句功能相当于“ * + stat_poi += 1; ”软件编程规范总则 5 变量、结构仅供内部使用 225 变量、结构5-1：去掉没必要的公共变量。说明：公共变量是增大模块间耦合的原因之一，故应减少没必要的公共变量以降低模块间的耦合度。5-2：仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。说明：在对变量声明的同时，应对其含义、作用及取值范围进行注释说明，同时若有必要还应说明与其它变量的关系。5-3：明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创

25、建等。说明：明确过程操作变量的关系后，将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。示例：在源文件中，可按如下注释形式说明。RELATION System_Init Input_Rec Print_Rec Stat_ScoreStudent Create Modify Access AccessScore Create Modify Access Access, Modify注：RELATION 为操作关系；System_Init、Input_Rec 、Print_Rec、Stat_Score 为四个不同的函数；Student、Score 为两

26、个全局变量；Create 表示创建，Modify 表示修改，Access表示访问。其中，函数 Input_Rec、Stat_Score 都可修改变量 Score，故此变量将引起函数间较大的耦合，并可能增加代码测试、维护的难度。5-4：当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。说明：对公共变量赋值时，若有必要应进行合法性检查，以提高代码的可靠性、稳定性。5-5：防止局部变量与公共变量同名。说明：若使用了较好的命名规则，那么此问题可自动消除。5-6：严禁使用未经初始化的变量作为右值。说明：特别是在 C/C+中引用未经赋值的指针，经常会引起系统崩溃。软件编程规范总则 5

27、变量、结构仅供内部使用 235-1：构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共变量，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。说明：降低公共变量耦合度。5-2：使用严格形式定义的、可移植的数据类型，尽量不要使用与具体硬件或软件环境关系密切的变量。说明：使用标准的数据类型，有利于程序的移植。示例：如下例子（在 DOS 下 BC3.1 环境中），在移植时可能产生问题。void main()register int index; / 寄存器变量_AX = 0x4000; / _AX 是 BC3.1 提供的寄存器“伪变量”. / program code

28、5-3：结构的功能要单一，是针对一种事务的抽象。说明：设计结构时应力争使结构代表一种现实事务的抽象，而不是同时代表多种。结构中的各元素应代表同一事务的不同侧面，而不应把描述没有关系或关系很弱的不同事务的元素放到同一结构中。示例：如下结构不太清晰、合理。typedef struct STUDENT_STRUunsigned char name8; /* students name */unsigned char age; /* students age */unsigned char sex; /* students sex, as follows */* 0 - FEMALE; 1 - MAL

29、E */unsigned char teacher_name8; /* the student teachers name */unisgned char teacher_sex; /* his teacher sex */ STUDENT;若改为如下，可能更合理些。软件编程规范总则 5 变量、结构仅供内部使用 24typedef struct TEACHER_STRUunsigned char name8; /* teacher name */unisgned char sex; /* teacher sex, as follows */* 0 - FEMALE; 1 - MALE */ T

30、EACHER;typedef struct STUDENT_STRUunsigned char name8; /* students name */unsigned char age; /* students age */unsigned char sex; /* students sex, as follows */* 0 - FEMALE; 1 - MALE */unsigned int teacher_ind; /* his teacher index */ STUDENT;5-4：不要设计面面俱到、非常灵活的数据结构。说明：面面俱到、灵活的数据结构反而容易引起误解和操作困难。5-5：不

31、同结构间的关系不要过于复杂。说明：若两个结构间关系较复杂、密切，那么应合为一个结构。示例：如下两个结构的构造不合理。typedef struct PERSON_ONE_STRUunsigned char name8;unsigned char addr40;unsigned char sex;unsigned char city15; PERSON_ONE;typedef struct PERSON_TWO_STRUunsigned char name8;unsigned char age;unsigned char tel; PERSON_TWO;软件编程规范总则 5 变量、结构仅供内部使用

32、 25由于两个结构都是描述同一事物的，那么不如合成一个结构。typedef struct PERSON_STRUunsigned char name8;unsigned char age;unsigned char sex;unsigned char addr40;unsigned char city15;unsigned char tel; PERSON;5-6：结构中元素的个数应适中。若结构中元素个数过多可考虑依据某种原则把元素组成不同的子结构，以减少原结构中元素的个数。说明：增加结构的可理解性、可操作性和可维护性。示例：假如认为如上的_PERSON 结构元素过多，那么可如下对之划分。ty

33、pedef struct PERSON_BASE_INFO_STRUunsigned char name8;unsigned char age;unsigned char sex; PERSON_BASE_INFO;typedef struct PERSON_ADDRESS_STRUunsigned char addr40;unsigned char city15;unsigned char tel; PERSON_ADDRESS;typedef struct PERSON_STRUPERSON_BASE_INFO person_base;PERSON_ADDRESS person_addr;

34、 PERSON;软件编程规范总则 5 变量、结构仅供内部使用 265-7：仔细设计结构中元素的布局与排列顺序，使结构容易理解、节省占用空间，并减少引起误用现象。说明：合理排列结构中元素顺序，可节省空间并增加可理解性。示例：如下结构中的位域排列，将占较大空间，可读性也稍差。typedef struct EXAMPLE_STRUunsigned int valid: 1;PERSON person;unsigned int set_flg: 1; EXAMPLE;若改成如下形式，不仅可节省 1 字节空间，可读性也变好了。typedef struct EXAMPLE_STRUunsigned int

35、 valid: 1;unsigned int set_flg: 1;PERSON person ; EXAMPLE;5-8：结构的设计要尽量考虑向前兼容和以后的版本升级，并为某些未来可能的应用保留余地（如预留一些空间等）。说明：软件向前兼容的特性，是软件产品是否成功的重要标志之一。如果要想使产品具有较好的前向兼容，那么在产品设计之初就应为以后版本升级保留一定余地，并且在产品升级时必须考虑前一版本的各种特性。5-9：留心具体语言及编译器处理不同数据类型的原则及有关细节。说明：如在 C 语言中，static 局部变量将在内存“数据区”中生成，而非 static 局部变量将在“堆栈”中生成。这些细节

36、对程序质量的保证非常重要。5-10：编程时，要注意数据类型的强制转换。说明：当进行数据类型强制转换时，其数据的意义、转换后的取值等都有可能发生变化，而这些细节若考虑不周，就很有可能留下隐患。5-11：对编译系统默认的数据类型转换，也要有充分的认识。示例：如下赋值，多数编译器不产生告警，但值的含义还是稍有变化。软件编程规范总则 5 变量、结构仅供内部使用 27char chr;unsigned short int exam;chr = -1;exam = chr; / 编译器不产生告警，此时 exam 为 0xFFFF。5-12：尽量减少没有必要的数据类型默认转换与强制转换。5-13：合理地设计

37、数据并使用自定义数据类型，避免数据间进行不必要的类型转换。5-14：对自定义数据类型进行恰当命名，使它成为自描述性的，以提高代码可读性。注意其命名方式在同一产品中的统一。说明：使用自定义类型，可以弥补编程语言提供类型少、信息量不足的缺点，并能使程序清晰、简洁。示例：可参考如下方式声明自定义数据类型。下面的声明可使数据类型的使用简洁、明了。typedef unsigned char BYTE;typedef unsigned short WORD;typedef unsigned int DWORD;下面的声明可使数据类型具有更丰富的含义。typedef float DISTANCE;typed

38、ef float SCORE;5-15：当声明用于分布式环境或不同 CPU间通信环境的数据结构时，必须考虑机器的字节顺序、使用的位域及字节对齐等问题。说明：比如 Intel CPU 与 68360 CPU，在处理位域及整数时，其在内存存放的“顺序”正好相反。示例：假如有如下短整数及结构。unsigned short int exam;typedef struct EXAM_BIT_STRU /* Intel 68360 */unsigned int A1: 1; /* bit 0 7 */unsigned int A2: 1; /* bit 1 6 */软件编程规范总则 5 变量、结构仅供内

39、部使用 28unsigned int A3: 1; /* bit 2 5 */ EXAM_BIT;如下是 Intel CPU 生成短整数及位域的方式。内存： 0 1 2 . （从低到高，以字节为单位）exam exam 低字节 exam 高字节内存： 0 bit 1 bit 2 bit . （字节的各“位” ）EXAM_BIT A1 A2 A3如下是 68360 CPU 生成短整数及位域的方式。内存： 0 1 2 . （从低到高，以字节为单位）exam exam 高字节 exam 低字节内存： 7 bit 6 bit 5 bit . （字节的各“位” ）EXAM_BIT A1 A2 A3说明：

40、在对齐方式下，CPU 的运行效率要快得多。示例：如下图，当一个 long 型数（如图中 long1）在内存中的位置正好与内存的字边界对齐时，CPU 存取这个数只需访问一次内存，而当一个 long 型数（如图中的long2）在内存中的位置跨越了字边界时，CPU 存取这个数就需要多次访问内存，如i960cx 访问这样的数需读内存三次（一个 BYTE、一个 SHORT、一个 BYTE，由 CPU 的微代码执行，对软件透明），所有对齐方式下 CPU 的运行效率明显快多了。1 8 16 24 32- - - -| long1 | long1 | long1 | long1 |- - - -| | |

42、操作）等手段对其加以保护。说明：若对所使用的全局变量不加以保护，则此函数就不具有可重入性，即当多个进程调用此函数时，很有可能使有关全局变量变为不可知状态。示例：假设 Exam 是 int 型全局变量，函数 Squre_Exam 返回 Exam 平方值。那么如下函数不具有可重入性。unsigned int example( int para )unsigned int temp;Exam = para; / （*）temp = Square_Exam( );return temp;此函数若被多个进程调用的话，其结果可能是未知的，因为当（*）语句刚执行完后，另外一个使用本函数的进程可能正好被激活

43、，那么当新激活的进程执行到此函数时，将使 Exam 赋与另一个不同的 para 值，所以当控制重新回到 “temp = Square_Exam( )”后，计算出的 temp 很可能不是预想中的结果。此函数应如下改进。unsigned int example( int para )unsigned int temp;软件编程规范总则 6 函数、过程仅供内部使用 30申请信号量操作 / 若申请不到“信号量 ”，说明另外的进程正处于Exam = para; / 给 Exam 赋值并计算其平方过程中（即正在使用此temp = Square_Exam( ); / 信号），本进程必须等待其释放信号后，才

44、可继释放信号量操作 / 续执行。若申请到信号，则可继续执行，但其/ 它进程必须等待本进程释放信号量后，才能再使/ 用本信号。return temp;6-5：在同一项目组应明确规定对接口函数参数的合法性检查应由函数的调用者负责还是由接口函数本身负责，缺省是由函数调用者负责。说明：对于模块间接口函数的参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患；要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。6-1：防止将函数的参数作为工作变量。说明：将函数的参数作为工作变量，有可能错误地改变参数内容，所以很危险。对必须改变的参数，最好先用局部变量代之，最后再将该局部变量的内容赋给该参数。示例：下函数的实现不太好。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 )

展开阅读全文