匈牙利命名法
1 匈牙利命名法
匈牙利命名法是一种编程时的命名规范。基本原则是:变量名=属性+类型
+对象描述,其中每一对象的名称都要求有明确含义,可以取对象名字全称或名
字的一部分。命名要基于容易记忆容易理解的原则。保证名字的连贯性是非常重
要的。
举例来说,表单的名称为form,那么在匈牙利命名法中可以简写为frm,则
当表单变量名称为Switchboard 时,变量全称应该为frmSwitchboard。这样可以
很容易从变量名看出Switchboard 是一个表单;同样,如果此变量类型为标签,
那么就应命名成lblSwitchboard。可以看出,匈牙利命名法非常便于记忆,而且
使变量名非常清晰易懂,这样增强了代码的可读性,方便各程序员之间相互交流
代码。
这种命名技术是由一位能干的Microsoft 程序员查尔斯·西蒙尼(Charles
Simonyi) 提出的,他出生在匈牙利。在Microsoft 公司中和他一起工作的人被
教会使用这种约定。这对他们来说一切都很正常。但对那些Simonyi 领导的项
目组之外的人来说却感到很奇特,他们认为这是死板的表达方式,甚至说带有这
样奇怪的外观是因为它是用匈牙利文写的。从此这种命名方式就被叫做匈牙利命
名法。
现在,大部分程序员不管自己使用什么软件进行开发,或多或少都使用了这
种命名法。
2 一般规则
属性部分
全局变量g_
常量c_
c++类成员变量m_
静态变量s_
类型部分
指针p
函数fn
无效v
句柄h
长整型l
布尔b
浮点型f
双字dw
字符串s
短整型n
双精度浮点d
计数c(通常用cnt)
字符ch(通常用c)
整型i(通常用n)
字节by
字w
实型r
无符号u
描述部分
最大Max
最小Min
初始化Init
临时变量T(或Temp)
源对象Src
目的对象Dest
例如:
pfnEatApple : pfn 是类型描述,表示指向函数的指针,EatApple 是变量
对象描述,所以它表示指向EatApple 函数的函数指针变量。
3 共性规则
这里论述的共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规
则的前提下,再扩充特定的规则。
【规则3.1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。
标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来
命名。程序中的英文单词一般不会太复杂,用词应当准确。例如不要把
CurrentValue 写成NowValue。
【规则3.2】标识符的长度应当符合“min-length && max-information”原则。
几十年前老ANSIC 规定名字不准超过6 个字符,现今的C++/C 不再有此限
制。一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几
个字符不足为怪。那么名字是否越长约好?不见得! 例如变量名maxval 就比
maxValueUntilOverflow 好用。单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z
等,它们通常可用作函数内的局部变量。
【规则3.3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。
例如Windows 应用程序的标识符通常采用“大小写”混排的方式,如AddChild。
而Unix 应用程序的标识符通常采用“小写加下划线”的方式,如add_child。别把
这两类风格混在一起用。
【规则3.4】程序中不要出现仅靠大小写区分的相似的标识符。
例如:
int x, X; // 变量x 与X 容易混淆
void foo(int x); // 函数foo 与FOO 容易混淆
void FOO(float x);
【规则3.5】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者
的作用域不同而不会发生语法错误,但会使人误解。
【规则3.6】变量的名字应当使用“名词”或者“形容词+名词”。
例如:
float value;
float oldValue;
float newValue;
【规则3.7】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。
类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。
例如:
DrawBox(); // 全局函数
box->Draw(); // 类的成员函数
【规则3.8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
例如:
int minValue;
int maxValue;
int SetValue(… );
int GetValue(… );
【建议3.1】尽量避免名字中出现数字编号,如Value1,Value2 等,除非逻辑上的
确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的
名字(因为用数字编号最省事)。
4 简单的Windows 应用程序命名规则
下述的命名规则简单易用,比较适合于Windows 应用软件的开发。
【规则4.1】类名和函数名用大写字母开头的单词组合而成。
例如:
class Node; // 类名
class LeafNode; // 类名
void Draw(void); // 函数名
void SetValue(int value); // 函数名
【规则4.2】变量和参数用小写字母开头的单词组合而成。
例如:
int drawMode;
【规则4.3】常量全用大写的字母,用下划线分割单词。
例如:
const int MAX = 100;
const int MAX_LENGTH = 100;
【规则4.4】静态变量加前缀s_(表示static)。
例如:
void Init(… )
{
static int s_initValue; // 静态变量
…}
【规则4.5】如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。
例如:
int g_howManyPeople; // 全局变量
int g_howMuchMoney; // 全局变量
【规则4.6】类的数据成员加前缀m_(表示member),这样可以避免数据成员
与成员函数的参数同名。
例如:
void Object::SetValue(int width, int height)
{
m_width = width;
m_height = height;
}
【规则4.7】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以
为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL 的所有库
函数均以gl 开头,所有常量(或宏定义)均以GL 开头。
5 具体命名
变量的命名
应用匈牙利表示法,变量可用上表中的前缀代码来表示。另外,当一个变量
是由一个或几个子名构成时,每一个子名都要以大写字母开头。下面是几个例子:
Bool bSemaphore; //a boolean value
WORD dwMaxCount; //a 32-bit unsigned WORD
函数的命名
函数和变量的命名方式相同,但是没有前缀,换句话说,子名的第一个字母
要大写。下面是几个例子:
int PlotPixel(int ix,int iy,int ic);
void *MemScan(char *szString);
而且,下划线是非法的。例如,下面的函数名表示是无效的匈牙利表示法:
int Get_Pixel(int ix,int iy);
类型和常量的命名
所有的类型和常量都是大写字母,但名字中可以允许有下划线。如:
const LONG NUM_SECTORS=100; // a C++ style constant
#define MAX_CELLS ; // a C style constant
#define POWERUNIT 100; // a C style constant
typedef unsigned char UCHAR; // a user defined type
类的命名
类命名的约定可能要麻烦一点。但我也看到有很多人在使用这个约定,并独
立地进行补充。不管怎么说,所有C++的类必须以大写C 为前缀,类名字的每
一个子名的第一个字母都必须大写:
class CVector // the chinese mean of vector is 矢量
{
public:
CVector();
{
ix=iy=iz=imagnitude=0; //the chinese mean of magnitude is 大小
}
CVector(int x, int y, int z)
{
ix=x;
iy=y;
iz=z;
}
......
private:
int ix,iy,iz; //the position of the vector
int imagnitude; //the magnitude of the vector
......
}
参数的命名
函数的参数命名和标准变量命名的约定相同。但也不总是如此。如:
UCHAR GetPixel(int x,int y);
这种情况下,更准确的匈牙利的函数原型是:
UCHAR GetPixel(int ix,int iy);
6 匈牙利命名法的缺点
“匈牙利”法最大的缺点是烦琐,例如
int i, j, k;
float x, y, z;
倘若采用“匈牙利”命名规则,则应当写成
int iI, iJ, ik; // 前缀i 表示int 类型
float fX, fY, fZ; // 前缀f 表示float 类型
如此烦琐的程序会让绝大多数程序员无法忍受。
据考察,没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般
都不指定命名规则。命名规则对软件产品而言并不是“成败悠关”的事,我们不要
化太多精力试图发明世界上最好的命名规则,而应当制定一种令大多数项目成员
满意的命名规则,并在项目中贯彻实施。
小结:匈牙利命名法
匈牙利命名法
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; |
HWND | hCtl; | CString | pStr; |
POINT | pt; | CPoint | pt; |
SIZE | size; | CSize | size; |
RECT | rect; | CRect | rect; |
一般前缀命名规范
前缀 | 类型 | 实例 |
C | 类或结构 | CDocument,CPrintInfo |
m_ | 成员变量 | m_pDoc,m_nCustomers |
Microsoft MFC 宏命名规范
名称 | 类型 |
_AFXDLL | 唯一的动态连接库(Dynamic Link Library,DLL)版本 |
_ALPHA | 仅编译DEC Alpha 处理器 |
_DEBUG | 包括诊断的调试版本 |
_MBCS | 编译多字节字符集 |
_UNICODE | 在一个应用程序中打开Unicode |
AFXAPI | MFC 提供的函数 |
CALLBACK | 通过指针回调的函数 |
库标识符命名法
标识符 | 值和含义 |
u | ANSI(N)或Unicode(U) |
d | 调试或发行:D = 调试;忽略标识符为发行。 |
静态库版本命名规范
库 | 描述 |
NAFXCWD.LIB | 调试版本:MFC 静态连接库 |
NAFXCW.LIB | 发行版本:MFC 静态连接库 |
UAFXCWD.LIB | 调试版本:具有Unicode 支持的MFC 静态连接库 |
UAFXCW.LIB | 发行版本:具有Unicode 支持的MFC 静态连接库 |
动态连接库命名规范
名称 | 类型 |
_AFXDLL | 唯一的动态连接库(DLL)版本 |
WINAPI | Windows 所提供的函数 |
Windows.h中新的命名规范类型定义描述
WINAPI | 使用在API 声明中的FAR PASCAL 位置,如果正在编写一个具有导出API 人口点的DLL,则可以在自己的API 中使用该类型 |
CALLBACK | 使用在应用程序回叫例程,如窗口和对话框过程中的FAR PASCAL 的位置 |
LPCSTR | 与LPSTR 相同,只是LPCSTR 用于只读串指针,其定义类似(const char FAR*) |
UINT | 可移植的无符号整型类型,其大小由主机环境决定(对于Windows NT 和Windows 9x 为32 位);它是unsigned int 的同义词 |
LRESULT | 窗口程序返回值的类型 |
LPARAM | 声明lParam 所使用的类型,lParam 是窗口程序的第四个参数 |
WPARAM | 声明wParam 所使用的类型,wParam 是窗口程序的第三个参数 |
LPVOID | 一般指针类型,与(void *)相同,可以用来代替LPSTR |
变量命名规范
前缀 | 类型 | 描述 | 实例 |
ch | char | 8 位字符 | chGrade |
ch | TCHAR | 如果_UNICODE 定义,则为16 位字符 | chName |
b | BOOL | 布尔值 | bEnable |
n | int | (其大小依赖于操作系统) | nLength |
n | UINT | 无符号值(其大小依赖于操作系统) | nHeight |
w | WORD | 16 位无符号值 | wPos |
l | LONG | 32 位有符号整型 | lOffset |
dw | DWORD | 32 位无符号整型 | dwRange |
p * | 指针 |
| pDoc |
lp | FAR* | 远指针 | pszName |
psz | LPSTR | 32 位字符串指针 | lpszName |
lpsz | LPCSTR | 32 位常量字符串指针 | lpszName |
lpsz | LPCTSTR | 如果_UNICODE 定义,则为32 位常量字符串指针 | pszName |
h | handle | Windows 对象句柄 | hWnd |
lpfn | callback | 指向CALLBACK 函数的远指针 |
|
前缀 | 符号类型 | 实例 | 范围 |
IDD_ | 对话框资源 | IDD_SPELL_CHECK | 1~0x6FFF |
DR_ | 不同类型的多个资源共享标识 | IDR_MAIINFRAME | 1~0x6FFF |
HIDD_ | 对话框资源的Help 上下文 | HIDD_SPELL_CHECK | 0x20001~0x26FF |
IDB_ | 位图资源 | IDB_COMPANY_LOGO | 1~0x6FFF |
IDC_ | 光标资源IDC_PENCIL 1~0x6FFF | IDC_PENCIL | 1~0x6FFF |
IDI_ | 图标资源 | IDI_NOTEPAD | 1~0x6FFF |
ID_ | 来自菜单项或工具栏的命令 | D_TOOLS_SPELLING | 0x8000~0xDFFF |
HID_ | 命令Help 上下文 | HID_TOOLS_SPELLING | 0x18000~0x1DFFF |
IDP_ | 消息框提示 | IDP_INVALID_PARTNO | 8~0xDEEF |
HIDP_ | 消息框Help 上下文 | HIDP_INVALID_PARTNO | 0x30008~0x3DEFF |
IDS_ | 串资源 | IDS_COPYRIGHT | ~0x7EEF |
IDC_ | 对话框内的控件 | IDC_RECALC | 8~0xDEEF |