- 1、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。。
- 2、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
- 4、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
- 5、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们。
- 6、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 7、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
.
命名规则
1.1. 起个合适的名字
1.1.1. 类的名称(适用于 C++ )
类的名称要能告诉我们,这个类是什么。因此,类的名称通常是名词。
类的名字不需要告诉我们,它从哪个类继承而来的。
2 有时候加个后缀是很有用的。比如类是一个代理 (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++ )
用大写字母作为单词的分隔,每个单词的首字母大写,其它字母均小写。
名字的第一个字母应大写
2 不含有下划线 (_)
例如:
class NameOneTwo;
class Name;
1.3. 类库(或程序库)命名 (适用于 C/C++ )
使用命名空间防止名字冲突。
2 如果编译器没有实现命名空间,需要用前缀来避名名字冲突,不过前缀不要过长( 2 个字母
比较好)。
例如:
John Johnson 完成了一个数据结构的库,它可以使用 JJ 作为库的前缀,所以类名就象下面这
样:
class JjLinkList
{
}
1.4. 方法和函数的命名(适用于 C++ )
使用与类名相同的规则例如:
class NameOneTwo
{
public:
int DoIt();
void HandleError();
}
1.5. 类属性的命名(适用于 C++ )
;.
.
2
属性(通常是非公有数据成员)名字以字母
m 开头。
2
在 m(m_) 后面,使用与类名相同的规则。
2
m(m_)
总是位于其它修饰符(如表示指针的
p )的前面。
例如:
class NameOneTwo
{
public:
int
VarAbc();
int
ErrorNumber();
private:
int
mVarAbc;
int
mErrorNumber;
String*
mpName;
}
1.6. 方法和函数参数的命名(适用于 C++ )
第一个字母必须小写。
第一个字母后面的单词使用与类名相同的规则。例如:
class NameOneTwo
{
public:
int StartYourEngines(
EnginerSomeEngine,
EnginerAnotherEngine);
}
1.7. 局部变量的命名(适用于 C/C++ )
所有字母都用小写
2 使用下划线 _ 作为单词的分隔。
例如:
int
NameOneTwo::HandleError(int errorNumber)
{
;.
.
int error= OsErr();
Time time_of_error;
ErrorProcessor error_processor;
}
1.8. 指针变量的命名前缀(适用于 C/C++ )
2 指针变量多数情况应在前面加 p 。
2 星号 * 应靠近类型,而不是变量名。
例如:
String* pName=new String;
特别的: String* pName, name; 应分成两行来写:
String* pName;
String name;
1.9. 引用变量和返回引用函数的命名前缀(适用于 C++ )
2 引用必须用 r 作前缀修饰。
例如:
class Test
{
public:
v
文档评论(0)