本编码规范针对 C++ 语言。制定本规范的目的:
本文档分别对 C++ 程序的格式、注释、标识符命名、语句使用、函数、类运用、程序组织、公共变量等方面做出了要求。
规范分为两个级别——规则和建议。
规则级的规范要求学生必须要遵守,建议级的规范学生应尽量遵守。
级别:建议
描述:
#include
部分、#define
部分、类型声明和定义部分、实现部分等等。理由:段落分明,提高代码的可读性。
级别:规则
描述:
nCount = 2;
而不是 nCount=2;
?
和 :
前后均各加 1 个空格。,
和后续一个空格隔开。void GetDate(int x, int y);
void GetDate(int x,int y);
或 void GetDate(int x ,int y);
if, for, while, switch
和之后的 (
之间加一个空格。if, for, while, switch
之后的 )
与 {
之间加一个空格(同行的情况下)。do
和之后 {
之间加一个空格(同行的情况下)。case
的常数表达式之后、default
之后的 :
前面,要有一个空格。理由:提高代码的可读性。
级别:规则
描述:
.
和 ->
,以及 []
。::
前后使用空格。++
、--
、!
、&
、*
等。;
前不能有空格。理由:提高代码的可读性。
举例:
// 不要像下面这样写代码 m_pFont -> Font; // 应该写成这样 m_pFont->Font;
级别:规则
描述:对程序语句要按其逻辑进行水平缩进,以4个空格为一个缩进单位,使同一逻辑层次上的代码在列上对齐。
理由:提高代码的可读性。
级别:规则
描述:
较长的语句(长度大于80字符,包含缩进)要分成多行书写。
长表达式要在低优先级操作符处分新行,操作符放在新行之首,
划分出的新行要进行适当的缩进,缩进长度以4个空格为单位。
理由:提高代码的可读性。
举例:
// 下面是一个处理的较为合理的例子 nCount = Fun1(nl, n2, n3) + (nNumberl * GetDate(n4, n5, n6)) * nNumber1;
级别:规则
描述:
if, for, while, do...while, switch
的语句部分一定要用 {
和 }
括起来{
与控制语句同行或者,{
和 }
单独占一行,与控制语句的首字母应处在同一列上。}
单独占一行。但在 do...while
结构中,while
前的 }
不能单独占一行,必须和 while
同行。理由:这样做,能够划分出清晰的语句块,使语句的归属明确,使代码更加容易阅读和修改。
举例:
// 不要像下面这样写代码 if (x == 0) return; else while (x > min) x--; // 应该这样写 if (x == 0) { return; } else { while (x > min) { x--; } }
级别:规则
规则描述:一行只写一条程序语句或标号(仅针对 case
)。
理由:提高代码的可读性。
举例:
// 不要这样写 x = x0; y = y0; while (IsOk(x)) {x++;} // 应该这样写代码 x = x0; y = y0; while (IsOk(x)) { x++; }
级别:规则
描述:一次(一条声明、定义语句)只声明、定义一个变量。
理由:提高代码的可读性,方便加入后置注释。
举例:
// 不要这样写 int width, length; // 应该这样写 int width; int length;
级别:建议
描述:对于一个表达式,在一个二元、三元操作符操作的操作数的两边,应该放置 (
和 )
,直到最高运算逻辑。
理由:避免出现不明确的运算、赋值顺序,提高代码的可读性。
举例:
//下面这行代码 result = fact / 100 * number + rem; //最好写成这样 result = ((fact / 100) * number) + rem;
*
(Dereferencing)、&
和类型写在一起级别:规则
描述:在定义指针变量时,将操作符和类型写在一起。
理由:统一格式,提高代码的可读性。
举例:
// 不要像下面这样写代码 char *s; // 而应该写成这样 char* s;
这一部分对程序注释提出了要求。
程序中的注释是程序与日后的程序读者之间通信的重要手段。
良好的注释能够帮助读者理解程序,为后续阶段进行测试和维护提供明确的指导。
下面是关于注释的基本原则:
级别:规则
描述:
/*************************************************************** 【函数名称】 (必需) 【函数功能】 (必需) 【参数】 (必需。标明各参数是输入参数还是输出参数。) 【返回值】 (必需。解释返回值的意义。) 【开发者及日期】 (必需) 【更改记录】 (若有修改,则必需注明) ****************************************************************/
理由:提高代码的可读性。
规范级别:规则
描述:在类的声明之前,要给出足够而精练的注释。注释格式要求如下:
/*************************************************************** 【类名】 (必需) 【功能】 (必需) 【接口说明】 (必需) 【开发者及日期】 (必需) 【更改记录】 (若修改过则必需注明) ****************************************************************/
理由:提高代码的可读性。
级别:规则
描述:在头文件、实现文件的首部,一定要有文件注释,用来介绍文件内容。注释格式要求如下:
/*************************************************************** 【文件名】 (必需) 【功能模块和目的】 (必需) 【开发者及日期】 (必需) 【更改记录】 (若修改过则必需注明) ****************************************************************/
理由:提高代码的可读性。
级别:建议
描述:建议对每个空循环体给出确认性注释。
理由:提示自己和别人,这是空循环体,并不是忘了。
举例:
while (g_bOpen == 1) { // 空循环 }
case
共用一个出口的情况给出确认性注释级别:建议
描述:建议对多个 case
语句共用一个出口的情况给出确认性注释。
理由:提示自己和别人,这几个 case
语句确实是共用一个出口,并不是遗漏了。
举例:
switch (nNumber) { case 1: nCount++; break; case 2: case 3: nCount--; break; // 当 nNumber 等于 2 或 3 时,进行同样的处理 default: break; }
级别:建议
描述:
除上面说到的,对于以下情况,也应该考虑进行注释:
变量的声明、定义。通过注释,解释变量的意义、存取关系等;
例如:
int m_iNumber; // 记录图形个数。被 `SetDate()`、`GetDate()` 使用。
数据结构的声明。通过注释,解释数据结构的意义、用途等;
例如:
// 定义结构体,存储元件的端点。用于将新旧的端点对应。 typedef struct { short int nBNN; short int nENN; short int nBNO; short int nENO; } Element;
分支。通过注释,解释不同分支的意义;
例如:
if (m_iShortRadio == 0) // 三相的情况 { strvC.Format("%-10.6f", vC); straC.Format("%-10.6f", aC); } else if (m_iShortRadio == 1) // 两相的情况 { strvC = _T(""); straC = _T(""); }
调用函数。通过注释,解释调用该函数所要完成的功能;
例如:
SetDate(m_nNumber); // 设置当前的图形个数。
赋值。通过注释,说明赋值的意义;
例如:
m_bDraw = 1; // 将当前设置为绘图状态
程序块的结束处。通过注释,标识程序块的结束。
例如:
if (name == White) { ... if (age == 20) ... } // 年龄判断、处理结束 ... } // 姓名判断、处理结束
其它有必要加以注释的地方
理由:提高代码的可读性。
级别:建议
描述:同一个函数或模块中的行末注释应尽量对齐。
理由:提高代码的可读性。
举例:
nCount = 0; // 计数器,表示正在处理第几个数据块 BOOL bNeedSave; // 是否保存从服务器返回的数据 DWORD BytesWritten; // 写入的数据长度
级别:规则
描述:注释行的数量不得少于程序行数量的 1/3。
对标识符和文件的命名要求。
级别:规则
描述:
在程序中声明、定义的变量、常量、宏、类型、函数,在对其命名时应该遵守统一的命名规范。
具体要求如下:
表 2-1 作用域前缀
变量种类 | 作用域前缀要求 | 示例 |
---|---|---|
全局变量(注1) | g_ | g_iNumber 全局整型变量 |
全局指针变量(注2)、 文件作用域变量(注3) | g_p | g_pNumber |
对象级变量 | m_ | m_cClassCode 文件作用域整型变量 |
对象级指针变量、 文件作用域指针变量 | m_p | m_pNumber |
局部变量 | 无 | fPrice 局部单精度浮点型变量 |
静态局部变量 | s_ | s_Number |
注释:
- 在整个程序中可以使用
- 类内数据成员
- 文件中静态变量。只在某个
.c
文件中可以使用。
但如整个程序只有一个.c
文件,应当认为是全局变量
表2-2类型前缀
数据类型 | 类型前缀 | 示例 |
---|---|---|
char | c (优先级第3) | m_cClassCode 文件作用域整型变量 |
int | i (优先级第3) | g_iNumber 全局整型变量 |
short int | n (优先级第3) | m_nCount 文件作用域短整型变量 |
long int | l (优先级第3) | lCount 局部长整型变量 |
long long int | ll (优先级第3) | llBigCount 局部长长整型变量 |
用 unsigned 修饰 | u (优先级第2)(注1) | g_ulCount 全局无符号长整型变量 |
float | f (优先级第3) | fPrice 局部浮点型变量 |
double | r (优先级第3) | rPrice 局部浮点型变量 |
指针 | p (优先级第1) | g_pulPrice 全局指向无符号长整型的指针变量 |
注释:
- 但当仅为
unsigned int
时,用u
替换i
常量
常量的名字要全部大写,包括至少一个英文单词。
常量指:const
修饰的量。如 const int NUMBER = 100;
枚举量。如 enum Number{ONE,TWO, THREE};
宏
所有用宏形式定义的名字,包括宏常量和宏函数,名字要全部大写。
自定义类型类型
自定义类型名应以大写字母打头。
C++ 中自定义类型包括:
class
、struct
、enum
、union
、typedef
声明的类型、namespace
。
例如:
typedef struct Student;
class CMsgDia log;
函数名应以大写字母打头,由动词性英文单词或动宾型英文短语构成。
例如:void GetCount();
下面还有一些在命名时应该遵守的基本规范:
m_LastCount
中要大写L和C;_bFind
是不允许出现的变量;m_Find
和 M_FIND
;m_uErrorCode
表示错误的代码;理由:减少命名冲突;提高代码的可读性。
级别:规则
描述:
在程序中声明、定义的变量、常量、宏、类型、函数,它们的名字长度要在4至25个字符之内
(下限不包括前缀,上限包括名字中所有的字符)。
对于某些已经被普遍认同 的简单命名,可不受本规则的限制。
如 for 循环的循环记数变量,可使用 i
、j
、x
、y
等简单字符命名。
如名字过长,可使用缩写,缩写时应当尽可能保留影响发音的辅音字母.
例如: Index
可缩写为 Idx
,Button
可缩写为 Btn
,Solution
可缩写为 Sln
。
理由:名字长度应该在一个恰当的范围内,名字太长不够简洁,名字太短又不能清晰表达含义。
级别:建议
描述:
代码文件的名字要与文件中声明、定义的重要重要函数名字或整体功能描述基本保持一致,
使功能与类文件名建立联系。
如 math.h
包括的都是和数学运算相关的函数声明。
举例:
将类 CMsgDialog
的头文件和实现文件命名为 msgdialog.h
和 msgdialog.cpp
就是一种比较简单、恰当的方法。
理由:使应用程序容易理解。
对具体程序语句的使用要求。
级别:规则
描述:
在一条程序语句中,只应包含一个赋值操作符。赋值操作符包括:
=, +=, -=, *=, /=, %=, >>=, <<=, &=, |=, !=, ^=, ++, --
理由:避免产生不明确的赋值顺序。
举例:
// 不要这样写 b = c = 5; a = (b * c) + d++; // 应该这样写 c = 5; b = c; a = (b * c) + d; d++;
级别:建议
描述:
不要在控制语句 if, while, for
和 switch
的条件表达式中使用赋值操作符。
赋值操作符包括: =, +=, -=, *=, /=, %=, >>=, <<=, &=, |=, !=, ^=, ++, --
理由:
已个类似于 if (x = y)
这样的写法是不明确、不清晰的,
代码的作者也许是想写成这样:if (x == y)
。
举例:
//不要像下面这样写代码: if (x -= dx) { ... } //应该这样写: x -= dx; if (x) { ... }
级别:建议
描述:
在一个赋值表达式中:
理由:避免产生不明确的赋值顺序。
举例
// 不要像下面这样写代码: i = t[i++]; // 一个左值,在表达式中应该仅被赋值一次 a = b = c + a; // 对于多重赋值表达式,一个左值在表达式中仅应出现一次,不能重复出现。 i = t[i] = 15; // 对于多重赋值表达式,一个左值在表达式中仅应出现一次,不能重复出现。
级别:规则
描述:程序中不要使 goto
语句。
理由:
这条规则的目的是为了确保程序的结构化,因为滥goto语句会使程序流程无规则,可读性差。
Goto 语句只在一种情况下有使价值,就是当要从多重循环深处跳转到循环之外时,效率很高,
但对于一般要求的软件,没有必要费劲心思追求多么高的效率,
而且效率主要是取决于算法,而不在于个别的语句技巧。
级别:规则
描述:不要对浮点类型的数据做等于、不等于这些精确的比较判断,要用范围比较代替精确比较。
理由:
由于存在舍入的问题,计算枧内部不能精确的表示所有的十进制浮点数,
用等于、不等于这种精确的比较方法就可能得出与预期相反的结果。
所以应该用大于、小于等范围比较的方法代替精确比较的方法。
举例
// 不要像下面这样写代码: float number; ... if (number == 0) // 精确比较
switch
语句中每个分支结尾的要求级别:规则
描述:
switch
语句中的每一个 case
分支,都要以 break
作为分支的结尾
(几个连续的空 case
语句允许共一个)
理由:使代码更容易理解;减少代码发生错误的可能性。
switch
语句中的 default
分支级别:规则
描述:
在 switch
语句块中,一定要有 default
分支来处理其它情况。
仅在 switch
中所有 case
已经包含了被判定表达式全部取值范围时候,可以不受本规则限制。
理由:用来处理 switch
语句中默认、特殊的情况。
级别:规则
描述:在定义指针变量的同时,对其进行初始化。如果定义时还不能为指针变量赋予有效值,则使其指向 NULL
。
理由:减少使用未初始化指针变量的几率。
举例
// 不要这样写代码 int* y; y = &x; // 应该这样写 int* y = &x;
级别:规则
描述:
当指针变量所指的内存被释放后,应该赋予指针一个合理的值。
除非该指针变量本身将要消失这种情况下不必赋值,否则应赋予 NULL
。
理由:保证指针变量在其生命周期的全过程都指向一个合理的值。
规范级别:建议
规则描述:对于 if, while, for
等控制语句的条件表达式,建议使用正规的布尔格式。
理由:使代码更容易理解。
举例
//不要像下面这样写代码: whiIe (1) { ... } if (test) { ... } for (i = 1; function_call(i); i++) { ... } // 最好这样写: AlwaysTrue = true; while (AlwaysTrue == true) { ... } if (test == true) { ... } for (i = 1; function_call(i) == true; i++) { ... }
new
和 delete
规范级别:规则
规则描述:
局部的 new
和 delete
要成对出现;
new
要与 delete
对应,new[]
要与 delete[]
对应。
理由:防止内存泄露。
对函数的要求。
级别:规则
描述:函数体代码长度不得超过 100 行(不包括注释)。
理由:明确函数功能(一个函数仅完成一件事情),精确(而不是近似)地实现函数设计。
级别:建议
描述:将重复使用的简单操作编写成函数。
理由:对于重复使用的功能,虽然很简单,也应以函数的形式来处理,这样可以简化代码,使代码更易于维护。
级别:规则
描述:在声明和定义函数时,在函数参数列表中为各参数指定类型和名称。
理由:提高代码的可读性,改善可移植性。
举例
// 不要象下面这样写代码: f(int, char*); // 函数声明 ... f(int a, char* b) // 函数定义 { ... } // 应该这样写: f(int a, char* b); // 函数声明 ... f(int a, char* b) // 函数定义 { ... }
级别:规则
描述:要为每一个函数指定它的返回值。如果函数没有返回值,则要定义返回类型为 void
理由:提高代码的可读性;改善代码的可移植性。
级别:建议
描述:
函数调用语句中,在函数的参数列表中不要使赋值操作符。
赋值操作符包括: =, +=, -=, *=, /=, %=, >>=, <<=, &=, |=, !=, ^=, ++, --
理由:避免产生不明确的赋值顺序。
举例
//不要象下面这样写代码: void fun1(int a); void fun2(int b) { fun1(++b); // 注意这里! }
对程序组织的要求。
级别:规则
描述:
在一个头文件中,只应该包含对一个函数的声明或一类函数的声明,使类时则只包含一个类的声明。
当头文件中包含一类函数时,这些函数功能必须可以抽象为一个共同的单词或短语。
头文件是指以 .h
为后缀的文件
理由:提高代码的可读性和文件级别重的可能性。
级别:规则
描述:
在一个源文件中,只应该包含对一个函数的定义或一类函数的定义,使类时则只包含一个类的定义。
当源文件中包含一类函数时,这些函数功能必须可以抽象为一个共同的单词或短语。
源文件指以 .c
为后缀的代码文件。
理由:提高代码的可读性和文件级别重的可能性。
级别:规则
描述:
在头文件中只包含声明,不要包含全局变量和函数的定义。
但宏和 const
要分情况讨论,不一定受本规则限制。
理由:在头文件中只应该包含各种声明,而不应该包含具体的实现。
级别:规则
描述:
在源文件中只应该包含对全局变量、文件作域变量、和函数的定义,不应该包含任何声明。
声明应该统一放到头文件中去。但宏和 const
要分情况讨论,不一定受本规则限
理由:内外有别,限制细节知悉范围,提高代码的可读性和可靠性。
级别:规则
描述:只允许头文件被包含到其它的代码文件中去。
理由:改善程序代码的组织结构。
级别:规则
描述:头文件的格式应该类似于:
#ifndef <IDENT> #define <IDENT> ... #endif // 或者 #if !defined(<IDENT>) #define <IDENT> ... #endif
上面的 <IDENT>
是一个标识字符串,要求该标识字符串必须唯一。
建议使用该文件的大写文件名。
理由:避免对同一头文件的重复包含。
举例:
// 对于文件 `audit.h`,它的文件结构应该为: #ifndef AUDIT_H // 第一行 #define AUDIT_H // 第二行 ... #endif // 最后一行
对公共变量(全局变量)的要求。
级别:建议
描述:
在程序中要尽可能少的使公共变量。
在决定使用一个公共变量时,要仔细考虑,权衡得失。
理由:公共变量会增大模块间的耦合,甚至扩大错误传播范围。
级别:规则
描述:
当你真的决定使用公共变量时,要仔细定义并明确公共变量的含义、作用、取值范围、与其它变量间的关系。
明确公共变量与操作此公共变量的函数之间的关系,如访问、修改和创建等。
级别:规则
描述:防止公共变量与局部变量重名。
对类的要求。
规范级别:规则
规则描述:为每一个类显示定义默认构造函数。
理由:确保类的编写者考虑在类对象初始化时,可能出现的各种情况。
举例
class CMyClass { CMyClass(); ... };
规范级别:规则
规则描述:
当类中包含指针类型的数据成员时,必须显示的定义拷贝构造函数。
建议为每个类都显示定义拷贝构造函数。
理由:确保类的编写者考虑类对象在被拷贝时可能出现的各种情况。
举例,
class CMyClass { CMyClass(CMyClass& object); ... };
=
操作符规范级别:规则
规则描述:
当类中包含指针类型的数据成员时,必须显示重载 =
操作符。
建议为每个类都显示重载 =
操作符。
理由:确保类的编写者考虑将一个该类对象赋值给另一个该类的对象时,可能出现的各种情况。
举例:
//应该这样写代码 class CMyClass { ... operator = (const CMyClass& object); ... };
规范级别:规则
规则描述:为每一个类显示的定义析构函数。
理由:确保类的编写者考虑类对象在析构时,可能出现的各种情况。
举例
class CMyClass { ... ~CMyClass(); ... };
该规则参考自《Effective C++》中的条款14。
规范级别:规则
规则描述:基类的析构函数一定要为虚拟函数(virtual Destructor)
理由:保证类对象内存被释放之前,基类和派生类的析构函数都被调用。
规范级别:规则
规则描述:
在派生类中不要对基类中的非虚函数重新进行定义。
如果确实需要在派生类中对该函数进行不同的定义,那么应该在基类中将该函数声明为虚函数;
理由不要忘了,当通过一个指向对象的指针调用成员函数时,最终调用哪个函数取决于指针本身的类型,而不是指针当前所指向的对象。
new
,也应该重载操作符 delete
该规则参考自《Effective C++》中的条款10。
规范级别:规则
规则描述:如果你为一个类重载了操作符 new
,那你也应该为这个类重载操作符 delete
理由:操作符 new
和操作符 delete
需要一起合作。
规范级别:规则
规则描述:类对外的接囗应该是完全功能化的,类中可以定义 public
的成员函数,但不应
该有 public
的数据成员。
理由:
要想改变对象的当前状态,应该通过它的成员函数来实现,而不应该通过直接设置它的数据成员这种方法。
一个类的数据成员应该声明为 private
的,最起码也应该是 protected
的。
规范级别:建议
规则描述:当继承的层数超过5层时,问题就很严重了,需要有特别的理由和解释。
理由:
规范级别:建议
规则描述:
C++ 提供多继承的枳制。
多继承在描述某些事物时可能是非常有利的,甚至是必须的,
但我们在使用多继承的时,一定要慎重,在决定使用多继承时,确实要有非常充分的理由。
理由:
多继承会显著增加代码的复杂性,还会带来潜在的混淆。
比如在很多 C++ 书籍中提到的菱形继承问题
规范级别:建议
规则描述:类设计的同时,考虑类的可复用性。
下面这几条要求,不适合合并到上面任何一类,所以单独作为一部分。
级别:规则
描述:使 const
来定义常量,代替通过宏来定义常量的方法。
理由:在不损失效率的同时,使 const
常量比宏更加安全。
举例:
// 宏定义的方法 #define string "Hello world!" #define value 3 // 常量定义的方法可以代替宏,且要更好 const char* string = "Hello world!"; const int value = 3;
级别:规则
描述:使 inline
关键字声明函数为内联函数,代替有参数的宏。
理由:保证效率和安全,同时提高代码的可读性。
该规则参考自《More Effective C++》中的条款2。
规范级别:建议
规则描述:
C++ 提供的类型转换操作符
static_cast
, const_cast
, dynamic_cast
和 reinterpret_cast
代替 C 风格的类型转换符。
理由:
C 风格的类型转换符有两个缺点:
级别:规则
描述:将程序中不再到的、注释掉的代码及时清除掉。
理由:
理由不做太多的解释了吧?没有的东西就应该清理掉。
如果觉得这些代码你可能以后会到,可以备份到其它地方,而不要留在正式的版本里
以上就是我们目前要求 C++ 程序遵守的规范的全部内容。欢迎大家讨论、补充和修订。