C++编码规范完整版.doc

1.???命名规则

1.1.起个合适的名字

1.1.1.???类的名称（合用于C++）

2?类的名称要能告诉我们，这个类是什么。因此，类的名称通常是名词。

2?类的名字不需要告诉我们，它从哪个类继承而来的。

2?有时候加个后缀是很有用的。比如类是一个代理(Agents)时，起名叫DownloadAgent更能表达真实的意图。

1.1.2.???方法和函数的名称（合用于C/C++）

2?方法和函数通常都要执行某种行为，因此，名称要能清楚的说明它做什么：CheckForErrors()而不是ErrorCheck(),DumpDataToFile()而不是DataFile()。这样也可以很容易的区别函数和数据。

2?函数名总以动词开头，后面跟随其它名称。这样看起来更自然些。

2?可以加一些必要的后缀：

Max–表达取最大值

Cnt–表达当前的计数值

Key–表达键值

例如：RetryMax表达可接受的最大数，RetryCnt表达当前接受的数量。

2?前缀也同样有用：

Is–用于询问一些问题。只要看到Is开头，就知道这是一个查询。

Get–用于获取一个值。

Set–用于设立一个值。

例如：IsHitRetryLimit.

1.1.3.???具有度量单位的名称（合用于C/C++）

2?假如一个变量用于表达时间，重量或其它度量单位，应把度量单位添加到名称中，以便开发人员更早一步发现问题。

例如：

uint32mTimeoutMsecs;

uint32mMyWeightLbs;

1.1.4.???缩写名称不要所有大写（合用于C/C++）

2?无论是什么缩写名称，我们总以一个大写字母开头，后面跟随的字母所有用小写。

例如：

classFluidOz;????????????//而不是FluidOZ

classNetworkAbcKey;??????//而不是NetworkABCKey

1.2.类的命名（合用于C++）

2?用大写字母作为单词的分隔，每个单词的首字母大写，其它字母均小写。

2?名字的第一个字母应大写

2?不具有下划线(_)

例如：

??classNameOneTwo;?

??className;

1.3.类库（或程序库）命名（合用于C/C++）

2?使用命名空间防止名字冲突。

2?假如编译器没有实现命名空间，需要用前缀来避名名字冲突，但是前缀不要过长（2个字母比较好）。

例如：

JohnJohnson完毕了一个数据结构的库，它可以使用JJ作为库的前缀，所以类名就象下面这样：

??classJjLinkList

??{

??}

1.4.方法和函数的命名（合用于C++）

2?使用与类名相同的规则

例如：

??classNameOneTwo

??{

??public:

?????int????DoIt();

?????void???HandleError();

??}

1.5.类属性的命名（合用于C++）

2?属性（通常是非公有数据成员）名字以字母m开头。

2?在m(m_)?后面，使用与类名相同的规则。

2?m(m_)总是位于其它修饰符（如表达指针的p）的前面。

例如：

??classNameOneTwo

??{

??public:

?????int????VarAbc();

?????int????ErrorNumber();

??private:

?????int????????mVarAbc;

?????int????????mErrorNumber;

?????String*?????mpName;

??}

1.6.方法和函数参数的命名（合用于C++）

2?第一个字母必须小写。

2?第一个字母后面的单词使用与类名相同的规则。

例如：

??classNameOneTwo

??{

??public:

?????int????StartYourEngines(

??????????????????????????????EnginerSomeEngine,

??????????????????????????????EnginerAnotherEngine);

??}

1.7.局部变量的命名（合用于C/C++）

2?所有字母都用小写

2?使用下划线_作为单词的分隔。

例如：

??int

??NameOneTwo::HandleError(interrorNumber)

??{

?????int???????????error=OsErr();

?????Time??????????time_of_error;