Chinaunix首页 | 论坛 | 博客
  • 博客访问: 1791399
  • 博文数量: 600
  • 博客积分: 10581
  • 博客等级: 上将
  • 技术积分: 6205
  • 用 户 组: 普通用户
  • 注册时间: 2008-11-06 10:13
文章分类
文章存档

2016年(2)

2015年(9)

2014年(8)

2013年(5)

2012年(8)

2011年(36)

2010年(34)

2009年(451)

2008年(47)

分类: C/C++

2009-09-23 15:25:12

 

比较著名的命名规则当推Microsoft公司的匈牙利法,该命名规则的主要思想是在变量和函数名中加入前缀以增进人们对程序的理解。例如所有的字符变量均以ch为前缀,若是指针变量则追加前缀p。如果一个变量由ppch开头,则表明它是指向字符指针的指针。

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

int    i, j, k;

float x, y, z;

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

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

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

如此烦琐的程序会让绝大多数程序员无法忍受。

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

共性规则

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

 

l         【规则3-1-1标识符应当直观且可以拼读,可望文知意,不必进行解码

标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂,用词应当准确。例如不要把CurrentValue写成NowValue

 

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

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

 

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

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

 

l         【规则3-1-4程序中不要出现仅靠大小写区分的相似的标识符。

例如:

int x, X;     // 变量x X 容易混淆

void foo(int x);    // 函数foo FOO容易混淆

void FOO(float x);

 

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

 

l         【规则3-1-6变量的名字应当使用名词或者形容词+名词

例如:

float value;

float oldValue;

float newValue;

 

l         【规则3-1-7全局函数的名字应当使用动词或者动词+名词(动宾词组)。类的成员函数应当只使用动词,被省略掉的名词就是对象本身。

例如:

DrawBox();           // 全局函数

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

 

l         【规则3-1-8用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

例如:

int   minValue;

int   maxValue;

 

int   SetValue(…);

int   GetValue(…);

 

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

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

       作者对匈牙利命名规则做了合理的简化,下述的命名规则简单易用,比较适合于Windows应用软件的开发。

 

l         【规则3-2-1类名和函数名用大写字母开头的单词组合而成。

例如:

 class Node;                 // 类名

 class LeafNode;             // 类名

 void Draw(void);           // 函数名

 void SetValue(int value); // 函数名

 

l         【规则3-2-2变量和参数用小写字母开头的单词组合而成。

例如:

    BOOL flag;

    int drawMode;

 

l         【规则3-2-3常量全用大写的字母,用下划线分割单词。

例如:

    const int MAX = 100;

    const int MAX_LENGTH = 100;

 

l         【规则3-2-4静态变量加前缀s_(表示static)。

例如:

void Init(…)

{

       static int s_initValue;      // 静态变量

      

}

 

l         【规则3-2-5如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。

例如:

int g_howManyPeople;   // 全局变量

int g_howMuchMoney; // 全局变量

 

l         【规则3-2-6类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。

例如:

    void Object::SetValue(int width, int height)

    {

        m_width = width;

m_height = height;

}

 

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

简单的Unix应用程序命名规则
阅读(1401) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~