C++ Coding Guidelines

一、命名规则

　　1、class、struct、typedef以大写字母开头：　

// Wrong
class myClass
{


// OK
class MyClass
{

　2、变量以 作用域+下划线+变量名 命名：

s_：静态变量、单例

k_：全局常量

m_：其他类变量

// WRONG
bool m_NotMainCharacter;
bool m_Redraw; 

// OK
bool m_IsMainCharacter
bool m_HasToRedraw

本地变量使用小写字母开头

void Function(...) {
       float  myLocal1;
       int    currentStep = 0;
       ...
}

　　3、函数：1 使用大写字母开头。2 如果函数返回的值是函数内通过分配得到的，必须清晰地使用Allocate , Create等来命名。

// WRONG
Data* GetData()
{
       return new Data;
}


// OK
Data* AllocateData()
{
       return new Data;
}

Get/Set 直接地访问一个成员时使用Get/Set 来命名。

如果函数需要做额外的任务、做搜索等等，不要使用Get/Set 。

Getxxx函数应该返回一个已经计算好的、已经存在的成员。 

Compute/Find 需要经过冗长的计算时。

Initialize 做初始化一个对象时。

Create/Allocate 创建一个新对象时。

对于功能互补的函数使用互补的名字，start/end、pause/resume、show/hide、add/remove等。

 

函数没必要返回值时，不需要返回。例如函数总是返回true时，不需要返回一个bool。

// Useless
bool Player::IncreaseHealth(u32 iHealth)
{
       m_Health += iHealth;
       return true;
} 
 

// OK
void Player::IncreaseHealth(u32 iHealth)
{
       m_Health += iHealth;
}

函数参数应当和本地变量明显的区分，i_ 输入参数，o_ 输出参数，io_ 可被改变的输入参数。

// Ambigous
void Function1(const string& arg1, float& arg2, string& returnVal)
{

// OK
void Function1(const string& i_Arg1, float& io_Arg2, string& o_ReturnVal)
{

二、编码结构

　　1、类：

　　命名空间

尽量少用。命名空间可以避免两个库的名字冲突，但如果使用太多级，会增加混淆。

1 在每个主模块中使用至多1个命名空间。

2 使所有类属于同一个命名空间。

　　类的数量

每个.h和.cpp里只有一个类。如果不是必须，不要在头文件里#include ，如果在函数或者指针中使用了其他类，在文件里使用前置声明。

// WRONG
#include "MyClassB.h"
#include "MyClassC.h"
 
class MyClassA {
public:
       void SomeFunction(const& MyClassB);
 
protected:
       MyClassC* m_Member;
 
};


// OK
// In MyClassA.h
 
// Forward declaration
class MyClassB;
class MyClassC;
 
class MyClassA {
public:
       void SomeFunction(const& MyClassB);
 
protected:
       MyClassC* m_Member;
};


//-------------------------------
// And in MyClassA.cpp
#include "MyClassA.h"
#include "MyClassB.h"
#include "MyClassC.h"
 
void MyClassA::SomeFunction(const& MyClassB)
{
       ...
}

源文件里，头文件的引用顺序：

#include "precomp.h" // Module header / Precompilation header
 
#include "MyClassA.h" // Current Cpp file header
#include "OtherClass1.h" // other headers needed
#include "OtherClass2.h"
#include "OtherClass3.h"
 
#include <stdio.h> // System headers

　　构造函数

在构造函数里尽量初始化所有成员，并且尽量使用初始化列表。

绝不要在构造函数里使用memset 。

// make sure to initialize all variables
Object::Object():
 
{
       m_member1 = 0;
       m_member2  = false;
       ......
}


// but prefer this way..
Object::Object(): m_Member1(0), m_Member2(false)
{
......
}

// NEVER DO THIS :
class Object {
       ...
       std::string m_Name;
}
 
Object::Object()
{
       memset(this,0,sizeof(Object));
}

如果有几个可能矛盾的构造函数，显式的声明他们。

避免在构造函数里分配内存，使用分开的 Init/Uninit或Create/Destroy来分配、回收内存。

　　析构函数

如果类里有虚函数或者从一个虚类里继承下来，那，那么一定要声明为虚析构函数。

避免在析构函数里释放内存，内存应该提前被释放。

如果有内存分配，使用assert。

// OK
MyClass::~ MyClass () {
       ....
       ASSERT (m_Buffer == 0);
}
-          Always assign pointers to 0 after deleting them


// WRONG
void ReleaseMemory() {
       delete m_Buffer;
}

　　2、函数