c++命名规范

 

在引入细节之前，先说明一下命名规范的整体原则： 同一性 在编写一个子模块或派生类的时候，要遵循其基类或整体模块的命名风格，保持命名风格在整个模块中的同一性。 标识符组成 标识符采用英文单词或其组合，应当直观且可以拼读，可望文知意，用词应当准确。 最小化长度 && 最大化信息量原则 在保持一个标识符意思明确的同时，应当尽量缩短其长度。 避免过于相似 不要出现仅靠大小写区分的相似的标识符，例如“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++命名准则中最重要的部分： 变量的命名 变量名由作用域前缀＋类型前缀＋一个或多个单词组成。为便于界定，每个单词的首字母要大写。 对于某些用途简单明了的局部变量，也可以使用简化的方式，如：i, j, k, x, y, z .... 　 作用域前缀 作用域前缀标明一个变量的可见范围。作用域可以有如下几种： 前缀 说明 无 局部变量 m_ 类的成员变量（member） sm_ 类的静态成员变量（static member） s_ 静态变量（static） g_ 外部全局变量（global） sg_ 静态全局变量（static global） gg_ 进程间共享的共享数据段全局变量（global global） 除非不得已，否则应该尽可能少使用全局变量。 类型前缀 类型前缀标明一个变量的类型，可以有如下几种： 前缀 说明 n 整型和位域变量（number） l 长整型(long) by 位(BYTE) w WORD dw DWORD d double e 枚举型变量（enumeration） c 字符型变量（char） b 布尔型变量（bool） f 浮点型变量（float） p 指针型变量和迭代子（pointer） lp 远指针 lpsz 以/0结尾的字符串远指针     pfn 特别针对指向函数的指针变量和函数对象指针（pointer of function） g 数组（grid） h Windows对象句柄(handle)如： hWnd i 类的实例（instance） 对于经常用到的类，也可以定义一些专门的前缀，如：std::string和std::wstring类的前缀可以定义为"st"，std::vector类的前缀可以定义为"v"等等。 类型前缀可以组合使用，例如"gc"表示字符数组，"ppn"表示指向整型的指针的指针等等。 推荐的组成形式 变量的名字应当使用"名词"或者"形容词＋名词"。例如："nCode", "m_nState"，"nMaxWidth" .... 常量 C++中引入了对常量的支持，常量的命名规则如下： 常量的命名 常量名由类型前缀＋全大写字母组成，单词间通过下划线来界定，如：cDELIMITER, nMAX_BUFFER .... 类型前缀的定义与变量命名规则中的相同。

结构体、宏、枚举变量、联合体

全部由前缀+大写字母组成，单词间使用下划线界定。

结构体 宏 枚举变量 联合体

加小写前缀"tag"，之后以大写字母开头 大写字母组成，单词间使用下划线界定，例：#define MAXNUMBER 100 加小写前缀"enum" 加小写前缀"uni"

 

有关项目的全局变量用g_开始，类成员变量用m_，局部变量若函数较大则可考虑用l_用以显示说明其是局部变量。

 

前缀 类型 例子

 

g_ 全局变量 g_Servers

C 类或者结构体 CDocument，CPrintInfo

m_ 成员变量 m_pDoc，m_nCustomers

 

VC常用前缀列表：

前缀 类型 描述 例子

 

ch char 8位字符 chGrade

ch TCHAR 16位UNICODE类型字符 chName

b BOOL 布尔变量 bEnabled

n int 整型（其大小由操作系统决定） nLength

n UINT 无符号整型（其大小由操作系统决定） nLength

w WORD 16位无符号整型 wPos

l LONG 32位有符号整型 lOffset

dw DWORD 32位无符号整型 dwRange

p * Ambient memory model pointer 内存模块指针，指针变量 pDoc

lp FAR* 长指针 lpDoc

lpsz LPSTR 32位字符串指针 lpszName

lpsz LPCSTR 2位常量字符串指针 lpszName

lpsz LPCTSTR 32位UNICODE类型常量指针 lpszName

h handle Windows对象句柄 hWnd

lpfn (*fn)() 回调函数指针 Callback Far pointer to CALLBACK function lpfnAbort

 

 

匈牙利命名法是微软推广的一种关于变量、函数、对象、前缀、宏定义等各种类型的符号的命名规范。匈牙利命名法的主要思想是：在变量和函数名中加入前缀以增进人们对程序的理解。它是由微软内部的一个匈牙利人发起使用的，结果它在微软内部逐渐流行起来，并且推广给了全世界的Windows开发人员。下面将介绍匈牙利命名法，后面的例子里也会尽量遵守它和上面的代码风格。还是那句话，并不是要求所有的读者都要去遵守，但是希望读者作为一个现代的软件开发人员都去遵守它。

a Array 数组

b BOOL (int) 布尔(整数)

by Unsigned Char (Byte) 无符号字符(字节)

c Char 字符(字节)

cb Count of bytes 字节数

cr Color reference value 颜色(参考)值

cx Count of x (Short) x的集合(短整数)

dw DWORD(unsigned long) 双字(无符号长整数)

f Flags (usually multiple bit values) 标志(一般是有多位的数值)

fn Function 函数

g_ global 全局的

h Handle 句柄

i Integer 整数

l Long 长整数

lp Long pointer 长指针

m_ Data member of a class 一个类的数据成员

n Short int 短整数

p Pointer 指针

s String 字符串

sz Zero terminated String 以0结尾的字符串

tm Text metric 文本规则

u Unsigned int 无符号整数

ul Unsigned long (ULONG) 无符号长整数

w WORD (unsigned short) 无符号短整数

x,y x, y coordinates (short) 坐标值/短整数

v void 空