C++命名规则

来源:互联网 发布:epsonl455清零软件 编辑:程序博客网 时间:2024/05/19 11:44

From: http://www.360doc.com/content/12/0809/19/9290626_229273185.shtml

/结构

除了异常类等个别情况(不希望用户把该类看作一个普通的、正常的类之情况)外,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++命名准则中最重要的部分:

变量的命名变量名由作用域前缀+类型前缀+一个或多个单词组成。为便于界定,每个单词的首字母要大写。

对于某些用途简单明了的局部变量,也可以使用简化的方式,如:i, j, k, x, y, z ....

 

作用域前缀作用域前缀标明一个变量的可见范围。作用域可以有如下几种:
前缀说明局部变量m_类的成员变量(member)sm_类的静态成员变量(static member)s_静态变量(static)g_外部全局变量(global)sg_静态全局变量(static global)gg_进程间共享的共享数据段全局变量(global global)

除非不得已,否则应该尽可能少使用全局变量。

 

类型前缀类型前缀标明一个变量的类型,可以有如下几种:
前缀说明n整型和位域变量(number)e枚举型变量(enumeration)c字符型变量(char)b布尔型变量(bool)f浮点型变量(float)p指针型变量和迭代子(pointer)pfn特别针对指向函数的指针变量和函数对象指针(pointer of function)g数组(grid)i类的实例(instance)

对于经常用到的类,也可以定义一些专门的前缀,如:std::string和std::wstring类的前缀可以定义为"st",std::vector类的前缀可以定义为"v"等等。

类型前缀可以组合使用,例如"gc"表示字符数组,"ppn"表示指向整型的指针的指针等等。

 

推荐的组成形式变量的名字应当使用"名词"或者"形容词+名词"。例如:"nCode", "m_nState","nMaxWidth" ....

 

常量

C++中引入了对常量的支持,常量的命名规则如下:

常量的命名常量名由类型前缀+全大写字母组成,单词间通过下划线来界定,如:cDELIMITERnMAX_BUFFER ....

类型前缀的定义与变量命名规则中的相同。

 

枚举、联合、typedef

枚举、联合及typedef语句都是定义新类型的简单手段,它们的命名规则为:

枚举、联合、typedef的命名枚举、联合、typedef语句生成的类型名由全大写字母组成,单词间通过下划线来界定,如:FAR_PROCERROR_TYPE ....

 

宏、枚举值

宏、枚举值的命名宏和枚举值由全大写字母组成,单词间通过下划线来界定,如:ERROR_UNKNOWNOP_STOP ....