现在的位置: 首页 > 综合 > 正文

匈牙利命名法

2013年10月08日 ⁄ 综合 ⁄ 共 3638字 ⁄ 字号 评论关闭

独立博客文章链接:http://zhuyanfeng.com/archives/298

匈牙利命名法是一种编程时的命名规范。基本原则是:变量名=属性+类型+对象描述,其中每一对象的名称都要求有明确含义,可以取对象名字全称或名字的一部分。命名要基于容易记忆容易理解的原则。保证名字的连贯性是非常重要的。

举例来说,表单的名称为form,那么在匈牙利命名法中可以简写为frm,则当表单变量名称为Switchboard时,变量全称应该为frmSwitchboard。这样可以很容易从变量名看出Switchboard是一个表单;同样,如果此变量类型为标签,那么就应命名成lblSwitchboard。可以看出,匈牙利命名法非常便于记忆,而且使变量名非常清晰易懂,这样增强了代码的可读性,方便各程序员之间相互交流代码。

这种命名技术是由一位能干的Microsoft程序员查尔斯·西蒙尼(Charles Simonyi) 提出的,他出生在匈牙利。在Microsoft 公司中和他一起工作的人被教会使用这种约定。这对他们来说一切都很正常。但对那些Simonyi领导的项目组之外的人来说却感到很奇特,他们认为这是死板的表达方式,甚至说带有这样奇怪的外观是因为它是用匈牙利文写的。从此这种命名方式就被叫做匈牙利命名法。现在,大部分程序员不管自己使用什么软件进行开发,或多或少都使用了这种命名法。

1 一般规则

1. 属性部分


2. 类型部分


3. 描述部分

例如:

pfnEatApple:pfn是类型描述,表示指向函数的指针,EatApple是变量对象描述,所以它表示指向EatApple函数的函数指针变量。

2 共性规则

这里论述的共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规则的前提下,再扩充特定的规则。

【规则2.1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂,用词应当准确。例如不要把CurrentValue写成NowValue。

【规则2.2】标识符的长度应当符合“min-length && max-information”原则。几十年前老ANSIC规定名字不准超过6 个字符,现今的C++/C不再有此限制。一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。那么名字是否越长约好?不见得! 例如变量名maxval就比maxValueUntilOverflow好用。单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。

【规则2.3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。而Unix应用程序的标识符通常采用“小写加下划线”的方式,如add_child。别把这两类风格混在一起用。

【规则2.4】程序中不要出现仅靠大小写区分的相似的标识符。例如:

int x, X; // 变量x 与X 容易混淆
void foo(int x); // 函数foo 与FOO 容易混淆
void FOO(float x);

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

【规则2.6】变量的名字应当使用“名词”或者“形容词+名词”。例如:

float value;
float oldValue;
float newValue;

【规则2.7】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。例如:

DrawBox(); // 全局函数
box->Draw(); // 类的成员函数

【规则2.8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如:

int minValue;
int maxValue;
int SetValue(… );
int GetValue(… );

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

3 简单的Windows应用程序命名规则

下述的命名规则简单易用,比较适合于Windows 应用软件的开发。

【规则3.1】类名和函数名用大写字母开头的单词组合而成。例如:

class Node; // 类名
class LeafNode; // 类名
void Draw(void); // 函数名
void SetValue(int value); // 函数名

【规则3.2】变量和参数用小写字母开头的单词组合而成。例如:

int drawMode;

【规则3.3】常量全用大写的字母,用下划线分割单词。例如:

const int MAX = 100;
const int MAX_LENGTH = 100;

【规则3.4】静态变量加前缀s_(表示static)。例如:

void Init(… )
{
    static int s_initValue; // 静态变量
    …
}

【规则3.5】如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。例如:

int g_howManyPeople; // 全局变量
int g_howMuchMoney; // 全局变量

【规则3.6】类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。例如:

void Object::SetValue(int width, int height)
{
    m_width = width;
    m_height = height;
}

【规则3.7】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头,所有常量(或宏定义)均以GL开头。

4 具体命名

1. 变量的命名

应用匈牙利表示法,变量可用上表中的前缀代码来表示。另外,当一个变量是由一个或几个子名构成时,每一个子名都要以大写字母开头。下面是几个例子:

Bool bSemaphore; //a boolean value
WORD dwMaxCount; //a 32-bit unsigned WORD

2. 函数的命名

函数和变量的命名方式相同,但是没有前缀,换句话说,子名的第一个字母要大写。下面是几个例子:

int PlotPixel(int ix,int iy,int ic);
void *MemScan(char *szString);

而且,下划线是非法的。例如,下面的函数名表示是无效的匈牙利表示法:

int Get_Pixel(int ix,int iy);

3. 类型和常量的命名

所有的类型和常量都是大写字母,但名字中可以允许有下划线。如:

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

4. 类的命名

类命名的约定可能要麻烦一点。但我也看到有很多人在使用这个约定,并独立地进行补充。不管怎么说,所有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
    ......
}

5. 参数的命名

函数的参数命名和标准变量命名的约定相同。但也不总是如此。如:

UCHAR GetPixel(int x,int y);

这种情况下,更准确的匈牙利的函数原型是:

UCHAR GetPixel(int ix,int iy);

5 匈牙利命名法的缺点

“匈牙利”法最大的缺点是烦琐,例如

int i, j, k;
float x, y, z;

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

int iI, iJ, ik; // 前缀i 表示int 类型
float fX, fY, fZ; // 前缀f 表示float 类型

如此烦琐的程序会让绝大多数程序员无法忍受。据考察,没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般都不指定命名规则。命名规则对软件产品而言并不是“成败悠关”的事,我们不要花太多精力试图发明世界上最好的命名规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施。

以上内容整理自《百度文档》,原作者不详

【上篇】
【下篇】

抱歉!评论已关闭.