1、C语言编程规范总则前言为了提高源程序的质量和可维护性，最终提高公司软件产品生产力，我们有必要对公司软件产品的源程序的编写风格作出统一的规范约束。本规范总则是独立于具体语言的编程规则的总的原则，针对不同编程语言或应用环境的编程规范在遵守本规范总则的基础上，还必须遵守相应语言和就用环境的编程规范。本规范总则适用于公司所有产品以及对外合作委托开发产品的软件源程序。本规范总则的内容包括：排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量保证、代码编译、单元测试、程序版本与维护等。 本规范总则的示例都以C语言为背景，采用以下的术语描述： 规则：编程时强制必须遵守的原则。 建议：编程时必须加以考
2、虑的原则。 说明：对此规则或建议进行必要的解释。 示例：对此规则或建议从正、反两个方面给出例子。目 录1 排版 32 注释 73 标识符命名 154 可读性 185 变量、结构 206 函数、过程 277 可测性 368 程序效率 389 质量保证 4310 代码编辑、编译、审查 5011 代码测试、维护 5212 宏 5431.排版规则1-1：程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。规则1-2：相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if (!validNi(ni). / program coderepss
3、nInd = ssnDataindex.repssn_index;repssnNi = ssnDataindex.ni;应如下书写if (!validNi(ni). / program coderepssnInd = ssnDataindex.repssnIndex;repssnNi = ssnDataindex.ni;规则1-3：较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：permCountMsg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT
4、_SIZE_PER_FRAM * sizeof( _UL );actTaskTableframID * STAT_TASK_CHECK_NUMBER + index.occupied= statPoiindex.occupied;actTaskTabletaskno.durationTruOrFalse= SYSGetSccpStatisticState( statItem );reportOrNotFlag = (taskno ），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够
5、清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在 C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例：(1) 逗号、分号只在后面加空格。int a, b, c; (2)比较操作符, 赋值操作符 “=“、 “+=“，算术操作符“+“、“%“，逻辑操作符“a *= 2;a = b 2;(3)“!“、“、“+“、“-“、“ / 内容操作“*“与内容之间flag = !isEmpty; / 非操作“!“与内容之间p = / 地址操作“ / “+“,“-“与内
6、容之间(4)“-“、“.“ 前后不加空格。p-id = pid; / “-“指针前后不加空格(5) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显。if (a = b replicateNet = subSystemDataindex.ni;例 2：replicateIndex= subSystemDataindex.replicatesubSystemIndex;replicateNet = subSystemDataindex.ni;/* get replicate sub system index and net indicator *
7、/应如下书写/* get replicate sub system index and net indicator */replicateIndex= subSystemDataindex.replicatesubSystemIndex;replicateNet = subSystemDataindex.ni;规则2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例：/* active statistic task number */#define MAX_ACT_TASK_NUMBER
8、 1000#define 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 no
9、tify 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 11request*/;规则2-11 ：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。示例：/* The ErrorCode when SCCP translate */* Global Titl
10、e failure, as follows */ / 变量作用、含义/* 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 ：注释
11、与所描述内容进行同样的缩排。说明：可使程序排版整齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍感不方便。void exampleFun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two应改为如下布局。void exampleFun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two12规则2-13 ：将注释与其上面的代码用空行隔开。示例：如下例子，显得代码过于紧凑
12、。/* 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 ：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。规则2-15 ：对于 switch语句下的 case语句，如果因为特殊情况需要处
13、理完一个case后进入下一个case 处理，必须在该case 语句处理完、下一个case语句前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏 break 语句。示例（注意斜体加粗部分）：case CMD_UP: ProcessUp(); break;case CMD_DOWN: ProcessDown(); break;case CMD_FWD: ProcessFwd(); if (.)13.break;elseProcessCFW_B(); / now jump into case CMD_Acase CMD_A: ProcessA(); break;case CMD_
14、B: ProcessB(); break;case CMD_C: ProcessC(); break;case CMD_D: ProcessD(); break;.建议 2-1：避免在一行代码或表达式的中间插入注释。说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。建议 2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。建议 2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的
15、信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/* if receiveFlag is TRUE */14if (receiveFlag)而如下的注释则给出了额外有用的信息。 /* if mailTransferProtocol receive a message from links */if (receiveFlag)建议 2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束。说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。if (.)/ program codewhile (index b ) ? a :
16、b ;改为如下就很清晰了。int max (int a, int b)return (a b) ? a : b);value = max (a, b);或改为如下。#define MAX (a, b) (a) (b) ? (a) : (b)30value = MAX (a, b);建议 6-5：不要设计多用途面面俱到的函数。说明：多功能集于一身的函数，很可能使函数的理解、测试、维护等变得困难。建议 6-6：函数的功能应该是可以预测的，也就是只要输入数据相同就应产生同样的输出。说明：带有内部“存储器”的函数的功能可能是不可预测的，因为它的输出可能取决于内部存储器（如某标记）的状态。这样的函数既不
17、易于理解又不利于测试和维护。在C/C+语言中，函数的 static 局部变量是函数的内部存储器，有可能使函数的功能不可预测，然而，当某函数的返回值为指针类型时，则必须是 STATIC 的局部变量的地址作为返回值，若为 AUTO 类，则返回为错针。示例：如下函数，其返回值（即功能）是不可预测的。unsigned int integerSum( unsigned int base )unsigned int index;static unsigned int sum = 0; / 注意，是 static 类型的。/ 若改为 auto 类型，则函数即变为可预测。for (index = 1; index = base; index+)sum += index;return sum; .建议 6-7：避免设计多参数函数，不使用的参数从接口中去掉。说明：目的减少函数间接口的复杂度。建议 6-8：不要漏写函数入口参数，如下定义不可：void insertStudent（BYTE ， INT16） 应加上参数名：void insertStudent（BYTE name， INT16 age）
