C++编码规范

一、程序风格：

1、严格采用阶梯层次组织程序代码：各层次缩进的分格采用VC的缺省风格，即每层次缩进为4格，括号位于下一行。要求相匹配的大括号在同一列，对继行则要求再缩进4格。

2、提示信息字符串的位置 在程序中需要给出的提示字符串，为了支持多种语言的开发，除了一些给调试用的临时信息外，其他所有的提示信息必须定义在资源中。

3、对变量的定义，尽量位于函数的开始位置。

4、空行

①、在每个类声明之后、每个函数定义结束之后都要加空行；

②、在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。

 

5、代码行

①、一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。

②、if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

 

6、代码行内的空格

①、关键字之后要留空格。像const、virtual、inline、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像if、for、while等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。

②、函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。

③ 、‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。

④、 ‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。

⑤、赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如

“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、

“<<”,“^”等二元操作符的前后应当加空格。

⑥、一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。

⑦、像“［］”、“.”、“->”这类操作符前后不加空格。

⑧、对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for (i=0; i<10; i++)和if ((a<=b) && (c<=d))

 

7、长行拆分

①、代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。

②、长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。

 

8、if 语句

①、布尔变量与零值比较

不可将布尔变量直接与TRUE、FALSE或者1、0进行比较。 

①、整型变量与零值比较

应当将整型变量用“==”或“！=”直接与0比较。 假设整型变量的名字为value，它与零值比较的标准if语句如下：

if (value == 0) 

if (value != 0)

不可模仿布尔变量的风格而写成

if (value)    // 会让人误解 value是布尔变量

if (!value)

③、浮点变量与零值比较

不可将浮点变量用“==”或“！=”与任何数字比较。

④、指针变量与零值比较

应当将指针变量用“==”或“！=”与NULL比较。

 

9、公共变量、结构

①、去掉没必要的公共变量

说明：公共变量是增大模块间耦合的原因之一，故应减少没必要的公共变量以降低模块间的耦合度。

②、仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。

说明：在对变量声明的同时，应对其含义、作用及取值范围进行注释说明，同时若有必要还应说明与其它变量的关系。

③、明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。

说明：明确过程操作变量的关系后，将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。

④、当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。

说明：对公共变量赋值时，若有必要应进行合法性检查，以提高代码的可靠性、稳定性。

⑤、防止局部变量与公共变量同名。

说明：若使用了较好的命名规则，那么此问题可自动消除。

⑥、严禁使用未经初始化的变量作为右值。

说明：特别是在C/C++中引用未经赋值的指针，经常会引起系统崩溃。

⑦、构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共变量，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。

说明：降低公共变量耦合度。

⑧、不要设计面面俱到、非常灵活的数据结构。

说明：面面俱到、灵活的数据结构反而容易引起误解和操作困难。

⑨、仔细设计结构中元素的布局与排列顺序，使结构容易理解、节省占用空间，并减少引起误用现象。

 

10、内存管理

①、内存分配方式: 静态存储区、栈和堆

a.  用malloc和new申请内存时，应该检查内存是否为NULL

b.  为数组和动态内存赋初值

c.  避免下标越界

d.  申请与释放要配对，尽量避免跨域配对

e.  用free和delete释放后，要将指针设置为NULL

②、数组和指针：

a.  数组分配在静态存储区或者是栈区，字符数组的值可以改变，例如：char a[]="hello";a[0]='X';而指向常量字符串的指针的内容不可以改变。char *p="world";p[0]='X';但编译器发现不了这个问题。

b.  数组不可以直接赋值与比较，应该使用strcpy和strcmp函数

c.  sizeof(数组)=数组分配空间的大小，sizeof(指针)=4，对于如下情节应该分辨清楚

void func(int arr[100])的sizeof(arr)=4

void func(int (&arr)[100])的sizeof(arr)=400

char arr[100]的sizeof(arr)=100

char *arr[100]的sizeof(arr)=400

d.  若参数是个指针，不要尝试为其分配内存，因为编译器会为这个参数产生一个副本，而我们实际操作的就是这个副本。

 

11、函数重载：要善于应用重载来提高程序的质量

①、全局函数和类的成员函数同名不算重载，因为作用域不同。若要在类里面调用全局函数，可以前面加上::

②、注意隐式转换带来的二义性

void print(int x)

void print(float x)

区别成员被重载的标志：

a.  在同一个类中

b.  函数名相同，参数表不同

c.  virtual可有可无

覆盖表示派生类函数覆盖基类函数：

a.  不同的范围

b.  函数名字相同，参数相同

c.  基类函数必须有virtual关键字

隐藏规则：

a.  若派生类的函数与基类同名，但参数不同，此时无论有无virtual关键字都将被隐藏

b.  若派生类的函数与基类同名，且参数相同，但是基类函数没有virtual关键字，此时基类的函数将被隐藏

 

12、参数的缺省值的使用规则：

①、参数缺省值只能出现在函数的声明中，而不能出现在定义体中。

②、如果函数有多个参数，参数只能从后向前挨个儿缺省，否则将导致函数调用语句怪模怪样。

 

13、 函数内联

①. 内联兼具效率和安全性，尽量用内联代替宏代码

②. inline标志用在实现前而不是声明前

③. 内联是以代码膨胀为代价的，所以要慎用内联

二、命名规则：

1、变量名的命名规则

①、变量的命名规则要求用“匈牙利法则”。即开头字母用变量的类型，其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。 即： 变量名=变量类型+变量的英文意思（或缩写）。对非通用的变量，在定义时加入注释说明，变量定义尽量可能放在函数的开始处。见下表：

bool(BOOL) 用b开头 bIsParent

byte(BYTE) 用by开头 byFlag

short(int) 用n开头 nStepCount

long(LONG) 用l开头 lSum

char(CHAR) 用c开头 cCount

float(FLOAT) 用f开头 fAvg

double(DOUBLE) 用d开头 dDeta

void(VOID) 用v开头 vVariant

unsigned int（WORD） 用w开头 wCount

unsigned long(DWORD) 用dw开头 dwBroad

HANDLE（HINSTANCE） 用h开头 hHandle

DWORD 用dw开头 dwWord

LPCSTR(LPCTSTR) 用str开头 strString

用0结尾的字符串 用sz开头 szFileName

对未给出的变量类型要求提出并给出命名建议给技术委员会。

②、指针变量命名的基本原则为：

对一重指针变量的基本原则为： “p”+变量类型前缀+命名，如一个float*型应该表示为pfStat

对多重指针变量的基本规则为：二重指针： “pp”+变量类型前缀+命名

三重指针： “ppp”+变量类型前缀+命名 ......

③、全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount,即：变量名=g_+变量类型+变量的英文意思（或缩写）

④、静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_Inst,即：变量名=s_+ 变量类型+变量的英文意思（或缩写）

⑤、成员变量用m_开头,如一个长型成员变量定义为m_lCount;即：变量名=m_+变量类型 +变量的英文意思（或缩写）

⑥、对枚举类型（enum）中的变量，要求用枚举变量或其缩写做前缀。并且要求用大写。 如：enum cmEMDAYS { EMDAYS_MONDAY; EMDAYS_TUESDAY; …… }

⑦、对struct、union、class变量的命名要求定义的类型用大写。并要加上前缀，其内部变量的命名规则与变量命名规则一致。

结构一般用S开头 如：struct ScmNPoint {

int nX;//点的X位置

int nY; //点的Y位置 };

联合体一般用U开头 如: union UcmLPoint {

long lX;

long lY; }

类一般用C开头 如： class CcmFPoint {

public:

float fPoint; };

对一般的结构应该定义为类模板，为以后的扩展性考虑

如： template class CcmTVector3d { public: TYPE x,y,z; };

⑧、对常量（包括错误的编码）命名，要求常量名用大写，常量名用英文表达其意思。如：#define CM_FILE_NOT_FOUND CMMAKEHR(0X20B) 其中CM表示类别。

⑨、对const 的变量要求在变量的命名规则前加入c_,即：c_+变量命名规则；例如： const char* c_szFileName;

10、控件的命名应该尽量显示出是同一种控件，例如：若是Label控件的话，则应该全部以Label打头；

 

2、 函数的命名规范：

函数的命名应该尽量用英文表达出函数完成的功能。遵循动宾结构的命名法则，函数名中动词在前,并在命名前加入函数的前缀，函数名的长度不得少于8个字母。 例如： long cmGetDeviceCount(……);

 

3、函数参数规范：

①、 参数名称的命名参照变量命名规范。

②、 为了提高程序的运行效率，减少参数占用的堆栈，传递大结构的参数，一律采用指针或引用方式传递。

③、 为了便于其他程序员识别某个指针参数是入口参数还是出口参数，同时便于编译器检查错误，应该在入口参数前加入const标志。 

如： ……cmCopyString(const char * c_szSource, char * szDest)

4、引出函数规范： 对于从动态库引出作为二次开发函数公开的函数，为了能与其他函数以及Windows的函数区分，采用类别前缀+基本命名规则的方法命名。例如：在对动态库中引出的一个图象编辑的函数定义为 imgFunctionname(其中img为image缩写)。 现给出三种库的命名前缀：

①、 对通用函数库，采用cm为前缀。

②、 对三维函数库，采用vr为前缀。

③、 对图象函数库，采用img为前缀。 对宏定义，结果代码用同样的前缀。

 

5、文件名(包括动态库、组件、控件、工程文件等)的命名规范： 文件名的命名要求表达出文件的内容，要求文件名的长度不得少于5个字母，严禁使用象 file1,myfile之类的文件名。

三、注释规范：

1、函数头的注释：对于函数，应该从“功能”，“参数”，“返回值”、“主要思路”、“调用方法”、 “日期”六个方面用如下格式注释：

//程序说明开始

//==================================================//

// 功能： 从一个String 中删除另一个String。

// 参数： strByDelete,strToDelete

// （入口） strByDelete: 被删除的字符串（原来的字符串）

// （出口） strToDelete: 要从上个字符串中删除的字符串。

// 返回： 找到并删除返回1，否则返回0。（对返回值有错误编码的要

// 求列出错误编码）。

// 主要思路：本算法主要采用循环比较的方法来从strByDelete中找到

// 与strToDelete相匹配的字符串，对多匹配strByDelete

// 中有多个strToDelete子串）的情况没有处理。请参阅：

// 书名......

// 调用方法：......

// 日期：起始日期，如：2000/8/21.9:40--2000/8/23.21:45

//==================================================

// 函数名(……)

//程序说明结束

①、 对于某些函数，其部分参数为传入值，而部分参数为传出值，所以对参数要详细说明该参数是入口参数，还是出口参数；对于某些意义不明确的参数还要做详细说明（例如：以角度作为参数时，要说明该角度参数是以弧度（PI）,还是以度为单位）,对既是入口又是出口的变量应该在入口和出口处同时标明。等等。

②、 函数的注释应该放置在函数的头文件中，在实现文件中的该函数的实现部分应该同时放置该注释。

③、 在注释中应该详细说明函数的主要实现思路、特别要注明自己的一些想法，如果有必要则应该写明对想法产生的来由。对一些模仿的函数应该注释上函数的出处。

④、 在注释中详细注明函数的适当调用方法，对于返回值的处理方法等。在注释中要强调调用时的危险方面，可能出错的地方。

⑤、 对日期的注释要求记录从开始写函数到结束函数的测试之间的日期。

⑥、 对函数注释开始到函数命名之间应该有一组用来标识的特殊字符串。如果算法比较复杂，或算法中的变量定义与位置有关，则要求对变量的定义进行图解。 对难以理解的算法能图解尽量图解。

 

2、变量的注释： 对于变量的注释紧跟在变量的后面说明变量的作用。原则上对于每个变量应该注释，但对于意义非常明显的变量，如：i,j等循环变量可以不注释。 例如： long lLineCount //线的根数。

 

3、文件的注释： 文件应该在文件开头加入以下注释： / // 工程: 文件所在的项目名。

// 作者：**，修改者：**

// 描述:说明文件的功能。

// 主要函数：…………

// 版本: 说明文件的版本，完成日期。

// 修改: 说明对文件的修改内容、修改原因以及修改日期。

// 参考文献： ...... /

为了头文件被重复包含要求对头文件进行定义如下: #ifndef __FILENAME_H__ #define __FILENAME_H__ 其中FILENAME为头文件的名字。

4、其他注释： 在函数内我们不需要注释每一行语句。但必须在各功能模块的每一主要部分之前添加块注释，注释每一组语句，在循环、流程的各分支等，尽可能多加以注释。其中的循环、条件、选择等位置必须注释。 对于前后顺序不能颠倒的情况，建议在注释中增加序号。 例如： 在其他顺序执行的程序中，每隔3—5行语句，必须加一个注释，注明这一段语句所组成 的小模块的作用。对于自己的一些比较独特的思想要求在注释中标明。

 

四、程序健壮性：

1、函数的返回值规范： 对于函数的返回位置，尽量保持单一性，即一个函数尽量做到只有一个返回位置。(单入口单出口)。 要求大家统一函数的返回值，所有的函数的返回值都将以编码的方式返回。例如编码定义如下： #define CM_POINT_IS_NULL CMMAKEHR(0X200) : : 建议函数实现如下： long 函数名(参数,……) { long lResult; //保持错误号 lResult=CM_OK; //如果参数有错误则返回错误号 if(参数==NULL) { lResult=CM_POINT_IS_NULL; goto END; } …… END: return lResult; }

2、关于goto的应用： 对goto语句的应用，我们要求尽量少用goto语句。对一定要用的地方要求只能向后转移。

3、资源变量的处理（资源变量是指消耗系统资源的变量）：对资源变量一定赋初值。分配的资源在用完后必须马上释放，并重新赋值。

4、对复杂的条件判断，为了程序的可读性，应该尽量使用括号。

例：if(((szFileName!=NULL)&&(lCount>=0)))||(bIsReaded==TRUE))

五、可移植性：

1、高质量的代码要求能够跨平台，所以我们的代码应该考虑到对不同的平台的支持，特别是对windows98和windowsnt的支持。

2、由于C语言的移植性比较好，所以对算法函数要求用C代码，不能用C++代码。

3、对不同的硬件与软件的函数要做不同的处理 

六、其它编程经验

1、使用const提高函数的健壮性

①、对于非内部数据类型，应该将值传递改为const引用

②、对于内部数据类型，应该为值传递

③、const成员函数，对于不会修改成员变量的函数，应该加上const后缀

 

2、提高程序的效率

①、不要一味地追求程序的效率，应当在满足正确性、可靠性、健壮性、可读性等质量因素的前提下，设法提高程序的效率。

②、以提高程序的全局效率为主，提高局部效率为辅。

③、在优化程序的效率时，应当先找出限制效率的“瓶颈”，不要在无关紧要之处优化。

④、先优化数据结构和算法，再优化执行代码。

⑤、有时候时间效率和空间效率可能对立，此时应当分析那个更重要，作出适当的折衷。例如多花费一些内存来提高性能。

⑥、不要追求紧凑的代码，因为紧凑的代码并不能产生高效的机器码。

 

3、一些有益的建议

①、当心那些视觉上不易分辨的操作符发生书写错误。

我们经常会把“＝＝”误写成“＝”，象“||”、“&&”、“<=”、“>=”这类符号也很容易发生“丢1”失误。然而编译器却不一定能自动指出这类错误。

②、变量（指针、数组）被创建之后应当及时把它们初始化，以防止把未被初始化的变量当成右值使用。

③、当心变量的初值、缺省值错误，或者精度不够。

④、当心数据类型转换发生错误。尽量使用显式的数据类型转换（让人们知道发生了什么事），避免让编译器轻悄悄地进行隐式的数据类型转换。

⑤、当心变量发生上溢或下溢，数组的下标越界。

⑥、当心忘记编写错误处理程序，当心错误处理程序本身有误。

⑦、当心文件I/O有错误。

⑧、避免编写技巧性很高代码。

⑨、不要设计面面俱到、非常灵活的数据结构。

⑩、如果原有的代码质量比较好，尽量复用它。但是不要修补很差劲的代码，应当重新编写。

11、把编译器的选择项设置为最严格状态。

优先级	运算符	结合律
从   高   到   低   排   列	( )  [ ]  ->  .	从左至右
	!  ~  ++  --  （类型） sizeof +  -  *  &	从右至左
	*  /  %	从左至右
	+  -	从左至右
	<<  >>	从左至右
	<   <=   >  >=	从左至右
	==  !=	从左至右
	&	从左至右
	^	从左至右
	|	从左至右
	&&	从左至右
	||	从右至左
	?:	从右至左
	=  +=  -=  *=  /=  %=  &=  ^= |=  <<=  >>=	从左至右

 

其它：

    应该尽量让函数完成相应的检查参数的功能，这样就不用每次调用该函数时都去判断参数是否争取。