C++编码规范

【规则1-1】 程序块要采用缩进风格编写，缩进的空格数为4个。

 

【规则1-2】 对齐与缩进只使用空格键，不使用TAB键。说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐，不要使用会自动将8个空格变为一个TAB键的开发工具编辑代码。（可开发工具软件自动将TAB键转换为4个空格）

 

【规则1-3】 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。

 

【规则1-4】 相对独立的程序块之间、变量说明之后必须加空行（一个空行即可）。

 

【规则1-5】 一行程序以小于80字符为宜，不要写得过长。

 

【规则1-6】 较长的语句（>80字符）要尽量分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。

 

【规则1-7】 循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

 

【规则1-8】 若函数或过程中的参数较长，则要进行适当的划分。

 

【规则1-9】 不允许把多个短语句写在一行中，即一行只写一条语句。

 

【规则1-10】  if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

 

【规则1-11】  程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用缩进方式。

 

【规则1-12】  在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C++语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

1、     逗号、分号只在后面加空格。

2、     比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。

3、     "!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后可以不加空格。

4、     "->"、"."前后不加空格。

5、     if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。

 

【规则1-13】  注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。说明：防止阅读程序时产生误解，防止因默认的优先级与设计思想不符而导致程序出错。

 

【规则1-14】避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。

 

【规则1-15】  源程序中关系较为紧密的代码应尽可能相邻。

 

【规则1-16】  不要使用难懂的技巧性很高的语句，除非很有必要时。

2、命名

【规则2-1】 每一个C++类必须使用一个独立的源文件进行书写（一个.h文件或一个.h和.cpp文件）；并且要求文件名称必须与类名相同（注意：文件名称必须大小写敏感）。

 

【规则2-2】 变量命名必须符合以下约束：

l       变量名称中独立单词的首字母必须大写，其它字母小写。

l       变量名称中的独立单词为标准术语的缩写词汇，允许全部大写。

l       变量名称中的独立单词一般情况下必须使用全称，允许在适当的情况下使用缩写，常见单词缩写参见附录A。

l       变量名称之前必须附加前缀用来识别变量类型，前缀标准定义如下：

类型	前缀	备注
short int long	n	带符号整数
unsigned short unsigned integer unsigned long	u	无符号整数
char unsigned char	c	字符
float double	f	浮点数
bool	b	布尔量
char* unsigned char*	sz	程序中明确作为字符串使用
char* unsigned char*	bf	程序中明确存放的是二进制数据
WORD	w	Windows平台专用
DWORD	dw	Windows平台专用
类	o	所有类定义的实例对象一律使用“o”作为前缀
指针	p	一般p后面会跟随一个指示具体类型的前缀，例如“pu”表示一个无符号数指针，“po”表示一个对象指针
指针的指针	pp	其它更多指针依此类推

 

l       针对基本类型重定义的新类型，前缀参照原始数据类型的前缀，例如“size_t”类型前缀为“u”。

l       C++类和结构的成员变量名在符合前面的规范基础上再附加前缀“m_”。

l       跨模块使用的全局变量名称在符合前面的规范基础上再附加前缀“g_”。

l       模块内部使用的全局变量名称在符合前面的规范基础上再附加前缀“_g_”。

l       单字符变量只能用作循环变量。

 

【规则2-3】 函数命名必须符合以下约束：

l       函数名称中独立单词的首字母必须大写，其它字母小写（特例：允许第一个单词首字母小写）。

l       函数名称中第一个单词必须是动词，尽量不使用缩写（除非是众所周知的缩写单词）。

l       函数名称中的独立单词为标准术语的缩写词汇，允许全部大写。

函数名称中的独立单词一般情况下必须使用全称，允许在适当的情况下使用缩写，常见单词缩写参见附录A

3、注释

【规则3-1】 本规范规定程序注释采用文档生成工具DOXYGEN进行处理。

 

【规则3-2】 源文件.cpp、头文件.h文件及其它说明性文件头部必须进行注释，注释如下格式所示。

 

/**   @file       程序文件名称（如ByteBuffer.cpp）   @brief    程序文件的简要说明                                       程序文件的详细说明（简要与详细说明之间间隔一个空行）   @author  作者姓名   @version   版本编号   修订日期 修订者 修订内容  */   注： l        注释必须以“/**”开头 l        允许存在多个@version指示符描述版本修订历程（每个@version指示符描述一个版本）

 

【规则3-3】 源程序模块函数接口（允许在其它模块使用的函数）必须注释，注释如下格式所示。

 

/**   @brief    函数的简要说明                                       函数的详细说明（简要与详细说明之间间隔一个空行）   @param  参数名称 参数说明   @return    返回值说明   @retval    值 返回值具体单个值说明 */   注： l        注释必须以“/**”开头 l        注释必须置于函数定义原型之上 l        允许存在多个@param指示符描述多个参数（每个@param指示符描述一个参数） l        允许存在多个@retval指示符描述多个具体的返回值说明（每个retval指示符描述一个返回值） l        @param、@return、@retval指示符均是可选项

 

【规则3-4】 源程序模块内部函数接口（即模块内部的私有函数）可以不必注释，一旦注释，采取如下格式所示。

 

/*   @brief    函数的简要说明                                       函数的详细说明（简要与详细说明之间间隔一个空行）   @param  参数名称 参数说明   @return    返回值说明   @retval    值 返回值具体单个值说明 */   注： l        注释必须以“/*”开头 l        注释必须置于函数定义原型之上 l        允许存在多个@param指示符描述多个参数（每个@param指示符描述一个参数） l        允许存在多个@retval指示符描述多个具体的返回值说明（每个retval指示符描述一个返回值） l        @param、@return、@retval指示符均是可选项 l        对于一些非常简单的模块内部私有函数可以使用简单注释，不作强制规范要求

 

【规则3-5】 源程序模块变量接口（允许在其它模块使用的变量）必须注释，注释如下格式所示（有两种注释格式）。

 

格式一：

/**   @brief    变量的简要说明                                       变量的详细说明（简要与详细说明之间间隔一个空行） */   注： l        注释必须以“/**”开头 l        注释必须置于变量定义之上

 

格式二：

///< 变量的说明   注： l        注释必须以“///<”开头 l        注释必须置于变量定义之后，与变量定义处于同一行

 

【规则3-6】源程序模块内部变量接口（即模块内部的私有变量）可以不必注释，一旦注释，采取如下格式所示（有两种注释格式）。

 

格式一：

/*   @brief    变量的简要说明                                       变量的详细说明（简要与详细说明之间间隔一个空行） */   注： l        注释必须以“/*”开头 l        注释必须置于变量定义之上

 

格式二：

// 变量的说明   注： l        注释必须以“//”开头 l        注释必须置于变量定义之后，与变量定义处于同一行

 

【规则3-7】 源程序模块自定义类型必须注释（含结构、C＋＋类等），注释如下格式所示。

 

/**   @brief    类型的简要说明                                       类型的详细说明（简要与详细说明之间间隔一个空行） */   注： l        注释必须以“/**”开头 l        注释必须置于类型定义之上 l        对子元素的注释可参照对函数、变量的注释格式

 

【规则3-8】 一般情况下，源程序有效注释量必须达到20％以上。

 

【规则3-9】 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

 

【规则3-10】  注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。

 

【规则3-11】  避免在注释中使用缩写，特别是非常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。

 

【规则3-12】 注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。

 

【规则3-13】 对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

 

【规则3-14】 数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。

 

【规则3-15】 全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

 

【规则3-16】 注释与所描述内容进行同样的缩排。说明：可使程序排版整齐，并方便注释的阅读与理解。

 

【规则3-17】 将注释与其上面的代码用空行隔开。

 

【规则3-18】 对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。

 

【规则3-19】 对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。

 

【规则3-20】 避免在一行代码或表达式的中间插入注释。说明：除非必要，不应在代码或表达式中间插入注释，否则容易使代码可理解性变差。

 

【规则3-21】 通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。

 

【规则3-22】 在代码的功能、意图层次上进行注释，提供有用、额外的信息。说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。

 

【规则3-23】 在程序块的结束行右方加注释标记，以表明某程序块的结束。说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。

 

【规则3-24】 注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。

4、源代码结构

【规则4-1】 本规范规定源代码结构必须符合如下规范：

l       源代码目录结构如下：

l       源代码目录结构说明如下：

 

名称	说明
doc	存放源代码相关的说明文档及通过Doxygen生成的源代码注释文档
include	存放程序使用的库程序的头文件及本程序提供给外部使用的头文件
src	存放程序中与平台无关的源代码
win32	存放Windows平台相关的源代码及Windows平台下的工程文件、编译临时文件和编译后的目标程序文件（debug和release版）
win32_release	存放Windows平台程序使用的库程序（dll和lib）及本程序提供给外部使用的库程序（dll和lib）（注：要求debug和release版本对应的库程序文件不同，例如在debug版本的库文件名后附加字符“d”）； 存放本程序编译的release版本程序文件
linux	存放Linux平台相关的源代码及Linux平台下的工程文件、编译临时文件和编译后的目标程序文件（debug和release版）
linux_release	存放Linux平台下本程序使用的库程序及本程序提供给外部使用的库程序； 存放Linux平台下本程序编译的release版本程序文件

注：

n       当需要同时编译成VC6和VS2005目标程序时，可以创建多个“win32_release”目录，目录名称可通过附加后缀进行区分，例如“win32_release.net”。

n       当需要同时编译成支持不同内核版本的Linux目标程序，可以创建多个“linux_release”目录，目录名称可通过附加内核版本作为后缀进行区分。

附录A：常见单词缩写表

单词	缩写
source	src
destination	dst
command	cmd
program	prg
send	snd
sender	sndr
receive	recv
receiver	recvr