高质量C++/C编程指南-第3章-命名规则(1)

第3章 命名规则
比较著名的命名规则当推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.1 共性规则
本节论述的共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规则的前提下,再扩充特定的规则,如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(); // 类的成员函数

时间: 2024-11-13 06:37:10

高质量C++/C编程指南-第3章-命名规则(1)的相关文章

高质量C++/C编程指南-第3章-命名规则(2)

l [规则3-1-8]用正确的反义词组命名具有互斥意义的变量或相反动作的函数等. 例如: int minValue; int maxValue; int SetValue(-); int GetValue(-); 2 [建议3-1-1]尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号.这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事). 3.2 简单的Windows应用程序命名规则作者对"匈牙利"命名规则做了合理的简

高质量C++/C编程指南-第10章-类的继承与组合(2)

10.2 组合l [规则10-2-1]若在逻辑上A是B的"一部分"(a part of),则不允许B从A派生,而是要用A和其它东西组合出B. 例如眼(Eye).鼻(Nose).口(Mouth).耳(Ear)是头(Head)的一部分,所以类Head应该由类Eye.Nose.Mouth.Ear组合而成,不是派生而成.如示例10-2-1所示. class Eye {public: void Look(void); };class Nose {public: void Smell(void);

高质量C++/C编程指南-第11章-其它编程经验(2)

11.1.3 const成员函数 任何不会修改数据成员的函数都应该声明为const类型.如果在编写const成员函数时,不慎修改了数据成员,或者调用了其它非const成员函数,编译器将指出错误,这无疑会提高程序的健壮性. 以下程序中,类stack的成员函数GetCount仅用于计数,从逻辑上讲GetCount应当为const函数.编译器将指出GetCount函数中的错误. class Stack { public: void Push(int elem); int Pop(void); int

高质量C++/C编程指南-第7章-内存管理(1)

欢迎进入内存这片雷区.伟大的Bill Gates 曾经失言: 640K ought to be enough for everybody - Bill Gates 1981 程序员们经常编写内存管理程序,往往提心吊胆.如果不想触雷,唯一的解决办法就是发现所有潜伏的地雷并且排除它们,躲是躲不了的.本章的内容比一般教科书的要深入得多,读者需细心阅读,做到真正地通晓内存管理. 7.1内存分配方式内存分配方式有三种: (1) 从静态存储区域分配.内存在程序编译的时候就已经分配好,这块内存在程序的整个运行

高质量C++/C编程指南-第4章-表达式和基本语句

读者可能怀疑:连if.for.while.goto.switch这样简单的东西也要探讨编程风格,是不是小题大做? 我真的发觉很多程序员用隐含错误的方式写表达式和基本语句,我自己也犯过类似的错误. 表达式和语句都属于C++/C的短语结构语法.它们看似简单,但使用时隐患比较多. 本章归纳了正确使用表达式和语句的一些规则与建议. 4.1 运算符的优先级 C++/C语言的运算符有数十个,运算符的优先级与结合律如表4-1所示.注意一元运算符 + - * 的优先级高于对应的二元运算符. 优先级 运算符 结合

高质量C++/C编程指南-第7章-内存管理(5)

7.9 内存耗尽怎么办?如果在申请动态内存时找不到足够大的内存块,malloc和new将返回NULL指针,宣告内存申请失败.通常有三种方式处理"内存耗尽"问题. (1)判断指针是否为NULL,如果是则马上用return语句终止本函数.例如: void Func(void) { A *a = new A; if(a == NULL) { return; } - } (2)判断指针是否为NULL,如果是则马上用exit(1)终止整个程序的运行.例如: void Func(void) { A

高质量C++/C编程指南-第6章-函数设计(3)

对于相加函数,应当用"值传递"的方式返回String对象.如果改用"引用传递",那么函数返回值是一个指向局部对象temp的"引用".由于temp在函数结束时被自动销毁,将导致返回的"引用"无效.例如: c = a + b; 此时 a + b 并不返回期望值,c什么也得不到,流下了隐患. 6.3 函数内部实现的规则不同功能的函数其内部实现各不相同,看起来似乎无法就"内部实现"达成一致的观点.但根据经验,我们可

高质量C++/C编程指南-第11章-其它编程经验(1)

11.1 使用const提高函数的健壮性看到const关键字,C++程序员首先想到的可能是const常量.这可不是良好的条件反射.如果只知道用const定义常量,那么相当于把火药仅用于制作鞭炮.const更大的魅力是它可以修饰函数的参数.返回值,甚至函数的定义体. const是constant的缩写,"恒定不变"的意思.被const修饰的东西都受到强制保护,可以预防意外的变动,能提高程序的健壮性.所以很多C++程序设计书籍建议:"Use const whenever you

高质量C++/C编程指南-第10章-类的继承与组合(1)

对象(Object)是类(Class)的一个实例(Instance).如果将对象比作房子,那么类就是房子的设计图纸.所以面向对象设计的重点是类的设计,而不是对象的设计. 对于C++程序而言,设计孤立的类是比较容易的,难的是正确设计基类及其派生类.本章仅仅论述"继承"(Inheritance)和"组合"(Composition)的概念. 注意,当前面向对象技术的应用热点是COM和CORBA,这些内容超出了C++教材的范畴,请阅读COM和CORBA相关论著. 10.1