命名规范

编程的命名规则，我第一反应就会想到匈牙利命名法。匈牙利命名法我都不想多说，因为网上的文章一大把，大家自己去google搜索。但是为了方便起见，我还是在这里简单的介绍一下：

匈牙利命名法通过在变量名前面加上相应的小写字母的符号标识作为前缀，标识出变量的作用域，类型等。

这些符号可以多个同时使用，顺序是

一、先m_（成员变量）或者是g_（全局变量）

二、就是指针，通常以p来表示

三、然后是简单数据类型

四、再是其他

例如：m_lpszStr, 表示 指向一个以 ‘/0’ 字符结尾的字符串的长指针成员变量。

匈牙利命名法关键是：

标识符的名字以一个或者多个小写字母开头作为前缀；

前缀之后的是首字母大写的一个单词或多个单词组合，该单词要指明变量的用途。

前缀
类型
a
数组 (Array)
b
布尔值 (Boolean)
by
字节 (Byte) == 8 bit
c
有符号字符 (Char)
cb
无符号字符 (Char Byte，没有多少人用)
cr
颜色参考值 (ColorRef)
cx,cy
坐标差（长度 ShortInt）
dw
双字 (Double Word) == 4 Byte == 4 * 8 bit
fn
函数(function)
h
句柄（Handle）
i
整型（int）
l
长整型 (Long int)
lp
长指针（Long Pointer）
m_
类的成员（member of a class）
n
短整型 (Short Int)
np
近指针（Near Pointer）
p
指针（Pointer）
s
字符串型（string）
sz
以字符’/0’结尾的字符串 (String with Zero End)
w
字(Word) == 2 Byte == 2 * 8 bit

但是在任何情况下，都硬性规定使用匈牙利命名法是迂腐的。尤其是 Unix 编程，在使用没有变量名、关键字自动补齐功能的编辑器，如 vi 下，去敲入大小写混合的变量名是痛苦的。

其实只要注意两个原则：
1) 含义清晰，不易混淆；
2) 不和其它模块、系统API的命名空间相冲突即可。

1. 有意识的为变量名、宏名加上本模块的关键字，就不至于和其它模块、系统API的命名空间相冲突；
   例如: 宏的名称过短，如：”DEBUG” 或 “_DEBUG”，很可能和别的模块，系统模块相冲突；
2. 局部变量尤其是循环变量外，使用约定俗成的 i,j,k ，没有问题；
3. 宏、常量、枚举enum，全部用大写字母；
4. 全局变量加上前缀 “g”，后面跟上首字母大写的单词；
   全局变量吗，费事一点可以谅解

MFC命名规则

Windows类型
样本变量
MFC类
样本变量
HWND
hWnd；
CWnd*
pWnd；
HDLG
hDlg；
CDialog*
pDlg；
HDC
hDC；
CDC*
pDC；
HGDIOBJ
hGdiObj；
CGdiObject*
pGdiObj；
HPEN
hPen；
CPen*
pPen；
HBRUSH
hBrush；
CBrush*
pBrush；
HFONT
hFont；
CFont*
pFont；
HBITMAP
hBitmap；
CBitmap*
pBitmap；
HPALETTE
hPaltte；
CPalette*
pPalette；
HRGN
hRgn；
CRgn*
pRgn；
HMENU
hMenu；
CMenu*
pMenu；
HWND
hCtl；
CState*
pState；
HWND
hCtl；
CButton*
pButton；
HWND
hCtl；
CEdit*
pEdit；
HWND
hCtl；
CListBox*
pListBox；
HWND
hCtl；
CComboBox*
pComboBox；
HWND
hCtl；
CScrollBar*
pScrollBar；
HSZ
hszStr；
CString
pStr；
POINT
pt；
CPoint
pt；
SIZE
size；
CSize
size；
RECT
rect；
CRect
rect；

还有一点想说明一下：
常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一条定义的右侧必须有一简单的注释,说明其作用;

下面是vc资源名字定义格式:
菜单: IDM_XX //M:Menu
位图: IDB_XX //B:Bitmap
对话框: IDD_XX //D:Dialog
字符串: IDS_XX //S:String
ICON: IDI_XX //I:Icon
按钮控件: IDC_BTN_XX //BTN:Button
编辑控件: IDC_EDT_XX //EDT:EditBox
列表控件： IDC_LST_XX //LST:ListCtrl
树表控件： IDC_TRE_XX //TRE:TreeCtrl
富文本控件： IDC_RCH_XX //RCH:RichEdit
静态本控件： IDC_STT_XX //STT:StaticText
组合框控件： IDC_CMB_XX //CMB:ComboBox
滚动条控件： IDC_SCR_XX //SCR:ScrollBar
滑动条控件： IDC_SLD_XX //SLD:Slider
多选项控件： IDC_CHK_XX //CHK:CheckBox
单选项控件： IDC_RDB_XX //RDB:RadioButton

---

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）
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++中引入了对常量的支持，常量的命名规则如下：

常量的命名 常量名由类型前缀＋全大写字母组成，单词间通过下划线来界定，如：cDELIMITER,nMAX_BUFFER ….
类型前缀的定义与变量命名规则中的相同。

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

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

宏、枚举值
宏和枚举值由全大写字母组成，单词间通过下划线来界定，如：ERROR_UNKNOWN, OP_STOP ….

据考证，没有一种命名规则可以让所有的程序员都满意，程序设计教科书一般也不会指定命名规则。但是制定一套令开发组成员基本满意的命名规则，并在项目中贯彻实施，也是团队开发一项必不可少的工作。

我将我的团队的实际工作中的命名规则整理如下：

第一部分：共性规则

共有八项。作为指导供成员采纳。

【规则1】标识符应简单明了，望文知意。

标识符采用英文单词。切忌使用汉语拼音来命名。程序中的英文单词一般不要太复杂，用词应当准确。例如不要把CurrentValue写成NowValue。

尽量不要使用单词缩写或首字母缩写。只有当标识符过长时才考虑使用单词缩写。在使用缩写时，不要自创缩写，尽量使用被广泛接受的缩写。

【规则2】标识符长度应当符合“min-length && max-information”原则。

一般的讲，长名字能更好地表达含义，所以函数名、变量名、类名长达十几个字符不足为怪。但是名字也不是越长越好。例如：变量名maxval就比maxValueUntilOverflow更好用。单字符的名字也是有用的，常见的如i,j,k,m,n,x,y,z等，它们通常用作函数内的局部变量。

【规则3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。

例如Windows应用程序的标识符通常采用“大小写”混排的方式，如AddChild。而Unix应用程序的标识符通常采用“小写加下划线”的方式，如add_child。别把这两类风格混在一起用。

【规则4】程序中不要出现仅靠大小写区分的标识符。

例如：int x和int X；void foo() 和void FOO() 等。

【规则5】避免在不同级别的作用域中重名。

程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者因作用域的不同而不会发生语法错误，但会使人产生误解。

【规则6】正确命名具有互斥意义的标识符。

使用正确的反义词组命名具有互斥意义的变量或相反动作的函数。

如：”MinValue”和”MaxValue”，”GetName()” 和 “SetName()”

【规则7】尽量避免名字中出现数字编号。

如Value1,Value2等，除非逻辑上的确需要编号。这是为了防止程序产生无意义的名字，降低程序的可读性。

【规则8】使用库标志

在开发动态库时，为了防止软件库中的一些标识符和其它软件库中标识符冲突，可以为各种标识符加上能反映软件性质的前缀。

例如三维图形标准OpenGL的所有库函数均以gl开头，所有常量（或宏定义）均以GL开头。

第二部分：细则

  我采用了一部分的“匈牙利”法命名规范，但没有照搬。“匈牙利”法最大的特征就是类型前缀。例如：

int nNum = 0; // n 为类型信息，表明 nNum 是一个 int 类型

class CUser; // C 为类型信息，表明 CUser 是一个类

但是正因为如此，“匈牙利”法命名规范也给人一种繁琐的感觉。例如：

int i, j, k;

float x, y, z;

倘若采用“匈牙利”命名规则，则应当写成：

int iI, iJ, ik; // 前缀 i表示int类型

float fX, fY, fZ; // 前缀 f表示float类型

对于此类情况，我的处理方式是不加类型前缀。而对于下列情况我会加：

int iHeigh;

Bool bFlag;

总之，在我的命名规范中，类型前缀是一个可选的命名规则。下面分类进行详细的规范。

一、 类和接口

1、 命名：类名都以大写字母“C”开头，后跟一个或多个单词。每个单词的首字母要大写。接口以大写”I”开头，代表Interface。

2、 组成形式：推荐用”名词”或”形容词＋名词”的形式，例如：”CAnalyzer”, “CFastVector” ….

二、 函数

1、 命名：函数的名称由一个或多个单词组成。每个单词的首字母要大写。最长不得超过20个字符。

2、 组成形式：全局函数应当使用”动词”或者”动词＋名词”（动宾词组）的形式。例如：”gGetName()”, ” gDrawBox()”。

类成员函数应当只使用“动词”，被省略掉的名词就是对象本身。例如：

” box->Draw();”。

3、 全局函数：以小写前缀”g”开头。

4、 保护成员函数：开头应当加上一个下划线“_”以示区别，例如：”_SetState()”

5、 私有成员函数：开头应当加上两个下划线“__”，例如：”__DestroyImp()”

6、 虚函数：习惯以“Do”开头，如：”DoRefresh()”, “_DoEncryption()”

7、 回调和事件处理函数 ：习惯以单词“On”开头。例如：”_OnTimer()”, “OnExit()”

三、 变量

变量是程序中使用最多的标识符，变量的命名规范是一套C++命名规范中最重要的部分：

1、 命名：变量名由作用域前缀＋类型前缀＋一个或多个单词组成。变量用小写字母开头的单词组合而成，第二个单词的首字母要大写。例如：int nDrawMode。变量最长不得超过20个字符。

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

2、 组成形式：变量的名字应当使用”名词”或者”形容词＋名词”。例如：”nCode”, “m_nState”，”nMaxWidth”，” oldValue “，” newValue “。

3、 作用域前缀：作用域前缀标明一个变量的可见范围。作用域可以有如下几种：

前缀

说明

例子

无

局部变量

m_

类的成员变量（member）

Int m_width

ms_

类的静态成员变量（static member）

static int ms_initValue;

s_

静态变量（static）

static int s_initValue;

g_

外部全局变量（global）

int g_howManyPeople;

sg_

静态全局变量（static global）

gg_

进程间共享的共享数据段全局变量（global global）

说明：作用域前缀不同于下面的类型前缀，应该坚决执行。原因是：

1）变量作用域和链接性改变的情况是很少的，例如，很少的情况下会把一个成员变量改成静态变量

2）编程中使用的工具常常不会直观的显示变量的作用域和链接性

4、 类型前缀：作用域前缀标明一个变量的可见范围。类型前缀标明一个变量的类型，有如下几种：

前缀

说明

例子

b

布尔型变量（bool, BOOL）

bEnable

ch

字符型变量（char TCHAR）

chName

lpsz

LPSTR、LPCSTR、LPCTSTR

lpszName

n

整型和位域变量（int, UINT,__int32,__int64）

nLength

l

long

lOffset

by

BYTE

w

WORD

wPos

dw

DWORD

dwRange

f

浮点型变量（float）

d

double

p

指针型变量和迭代子（pointer）

pDoc

lp

远指针

e

枚举型变量（enumeration）

pfn

特别针对指向函数的指针变量和函数对象指针（pointer of function）

g

数组（grid）

h

handle Windows对象句柄

hWnd

四、 常量

常量名由类型前缀＋全大写字母组成，单词间通过下划线来界定，如：cDELIMITER, nMAX_BUFFER。类型前缀的定义与变量命名规则中的相同。

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

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

1、 结构体：加小写前缀”tag”，之后以大写字母开头。

例：

typedef struct tagPOINT

{

int x;

int y;

} POINT;

2、 宏：大写字母组成，单词间使用下划线界定

例：#define MAXNUMBER 100

3、 枚举变量：加小写前缀”enum”。

例：

typedef enum _FILE_OPEN_MODE

{

OPEN_READONLY，

OPEN_READWRITE

}FILE_OPEN_MODE;

4、 联合体：加小写前缀”uni”。

例：

typedef union _VARIANT

{

char unichVal;

int uninVal;

float uniftVal;

} VARIANT;