1. 命名规则

1.1.

 

起个合适的名字

1.1.1.

类的名称（适用于 C++）



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



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



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

1.1.2.

方法和函数的名称（适用于 C/C++）



方 法 和 函 数 通 常 都 要 执 行 某 种 行 为 ， 因 此 ， 名 称 要 能 清 楚 的 说 明 它 做 什 么 ：
CheckForErrors() 而不是 ErrorCheck(), DumpDataToFile() 

 

而不是 DataFile()  

。 这样也可以很

 

容易的区别函数和数据。



 

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



可以加一些必要的后缀：

Max – 

 

表示取最大值

Cnt – 

 

表示当前的计数值

Key – 

 

表示键值

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



 

前缀也同样有用：

Is – 用于询问一些问题。只要看到 Is

 

开头，就知道这是一个查询。

Get – 用于获取一个值。
Set – 用于设置一个值。

例如：IsHitRetryLimit. 

1.1.3.

含有度量单位的名称（适用于 C/C++）



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

 

例如：

uint32 mTimeoutMsecs;
uint32 mMyWeightLbs;

1.1.4.

缩写名称不要全部大写（适用于 C/C++）



 

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

 

例如：

class FluidOz;             // 

 

而不是 FluidOZ

class NetworkAbcKey;       // 

 

而不是 NetworkABCKey

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



 

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