1 / 4
文档名称:

命名规范的整体原则.doc

格式:doc   页数:4页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

命名规范的整体原则.doc

上传人:zbfc1172 2015/10/27 文件大小:0 KB

下载得到文件列表

命名规范的整体原则.doc

相关文档

文档介绍

文档介绍:命名规范的整体原则:(zz:http://blog./ariesjzj/archive/2007/08/08/ )
同一性
在编写一个子模块或派生类的时候,要遵循其基类或整体模块的命名风格,保持命名风格在整个模块中的同一性。

标识符组成
标识符采用英文单词或其组合,应当直观且可以拼读,可望文知意,用词应当准确。

最小化长度&& 最大化信息量原则
在保持一个标识符意思明确的同时,应当尽量缩短其长度。

避免过于相似
不要出现仅靠大小写区分的相似的标识符,例如“i”与“I”,“function”与“Function”等等。

避免在不同级别的作用域中重名
程序中不要出现名字完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但容易使人误解。

正确命名具有互斥意义的标识符
用正确的反义词组命名具有互斥意义的标识符,如:"nMinValue"和"nMaxValue","GetName()" 和"SetName()" ....

避免名字中出现数字编号
尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。

类/结构
除了异常类等个别情况(不希望用户把该类看作一个普通的、正常的类之情况)外,C++类/结构
的命名应该遵循以下准则:
C++类/结构的命名
类的名称都要以大写字母“C”开头,后跟一个或多个单词。为便于界定,每个单词的首字母要大写。

推荐的组成形式
类的命名推荐用"名词"或"形容词+名词"的形式,例如:"CAnalyzer", "CFastVector" ....
不同于C++类的概念,传统的C结构体只是一种将一组数据捆绑在一起的方式。传统C结构体的命名规则为:
传统C结构体的命名
传统C结构体的名称全部由大写字母组成,单词间使用下划线界定,例如:"SERVICE_STATUS", "DRIVER_INFO" ....

函数
函数的命名
函数的名称由一个或多个单词组成。为便于界定,每个单词的首字母要大写。

推荐的组成形式
函数名应当使用"动词"或者"动词+名词"(动宾词组)的形式。例如:"GetName()", "SetValue()", "Erase()", "Reserve()" ....

保护成员函数
保护成员函数的开头应当加上一个下划线“_”以示区别,例如:"_SetState()" ....

私有成员函数
类似地,私有成员函数的开头应当加上两个下划线“__”,例如:"__DestroyImp()" ....

虚函数
虚函数****惯以“Do”开头,如:"DoRefresh()", "_DoEncryption()" ....

回调和事件处理函数
回调和事件处理函数****惯以单词“On”开头。例如:"_OnTimer()", "OnExit()" ....

变量
变量应该是程序中使用最多的标识符了,变量的命名规范可能是一套C++命名准则中最重要的部分:
变量的命名
变量名由作用域前缀+类型前缀+一个或多个单词组成。为便于