三、 命名规则

比较著名的命名规则当推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节。

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

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

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

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

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

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

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

例如：

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

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

void FOO(float x); 

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

【规则3-1-6】变量的名字应当使用“名词”或者“形容词＋名词”。

例如：

float  value;

float  oldValue;

float  newValue;

【规则3-1-7】全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。

例如：

DrawBox(); // 全局函数

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

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

例如：

int minValue;

int maxValue;

int SetValue(…);

int GetValue(…);

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

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

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

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

例如：

class Node; // 类名

class LeafNode; // 类名

void  Draw(void); // 函数名

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

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

例如：

BOOL flag;

int  drawMode; 

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

例如：

const int MAX = 100;

const int MAX_LENGTH = 100; 

【规则3-2-4】静态变量加前缀s_（表示static）。

例如：

void Init(…)

{

static int s_initValue; // 静态变量

…

} 

【规则3-2-5】如果不得已需要全局变量，则使全局变量加前缀g_（表示global）。

例如：

int g_howManyPeople; // 全局变量

int g_howMuchMoney; // 全局变量 

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

例如：

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

{

m_width = width;

m_height = height;

} 

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

四、表达式和基本语句

读者可能怀疑：连if、for、while、goto、switch这样简单的东西也要探讨编程风格，是不是小题大做？

我真的发觉很多程序员用隐含错误的方式写表达式和基本语句，我自己也犯过类似的错误。

表达式和语句都属于C++/C的短语结构语法。它们看似简单，但使用时隐患比较多。本章归纳了正确使用表达式和语句的一些规则与建议。

4.1 运算符的优先级

C++/C语言的运算符有数十个，运算符的优先级与结合律如表4-1所示。注意一元运算符 +  -  * 的优先级高于对应的二元运算符。

 

优先级	运算符	结合律
从   高   到   低   排   列	( )  [ ]  ->  .	从左至右
	!  ~  ++  --  （类型） sizeof +  -  *  &	从右至左
	*  /  %	从左至右
	+  -	从左至右
	<<  >>	从左至右
	<   <=   >  >=	从左至右
	==  !=	从左至右
	&	从左至右
	^	从左至右
	|	从左至右
	&&	从左至右
	||	从右至左
	?:	从右至左
	=  +=  -=  *=  /=  %=  &=  ^= |=  <<=  >>=	从左至右

表4-1 运算符的优先级与结合律

 

【规则4-1-1】如果代码行中的运算符比较多，用括号确定表达式的操作顺序，避免使用默认的优先级。

由于将表4-1熟记是比较困难的，为了防止产生歧义并提高可读性，应当用括号确定表达式的操作顺序。例如：

word = (high << 8) | low

if ((a | b) && (a & c))

4.2 复合表达式

如 a = b = c = 0这样的表达式称为复合表达式。允许复合表达式存在的理由是：（1）书写简洁；（2）可以提高编译效率。但要防止滥用复合表达式。

【规则4-2-1】不要编写太复杂的复合表达式。

例如：

  i = a >= b && c < d && c + f <= g + h ; // 复合表达式过于复杂

【规则4-2-2】不要有多用途的复合表达式。

例如：

d = (a = b + c) + r ;

该表达式既求a值又求d值。应该拆分为两个独立的语句：

a = b + c;

d = a + r;

【规则4-2-3】不要把程序中的复合表达式与“真正的数学表达式”混淆。

例如：

if (a < b < c) // a < b < c是数学表达式而不是程序表达式

并不表示

if ((a<b) && (b<c))

而是成了令人费解的

if ( (a<b)<c )

4.3 if 语句

if语句是C++/C语言中最简单、最常用的语句，然而很多程序员用隐含错误的方式写if语句。本节以“与零值比较”为例，展开讨论。

4.3.1 布尔变量与零值比较

【规则4-3-1】不可将布尔变量直接与TRUE、FALSE或者1、0进行比较。

根据布尔类型的语义，零值为“假”（记为FALSE），任何非零值都是“真”（记为TRUE）。TRUE的值究竟是什么并没有统一的标准。例如Visual C++ 将TRUE定义为1，而Visual Basic则将TRUE定义为-1。

假设布尔变量名字为flag，它与零值比较的标准if语句如下：

if (flag) // 表示flag为真

if (!flag) // 表示flag为假

其它的用法都属于不良风格，例如：

if (flag == TRUE)

if (flag == 1 )

if (flag == FALSE)  

if (flag == 0)

4.3.2 整型变量与零值比较

【规则4-3-2】应当将整型变量用“==”或“！=”直接与0比较。

假设整型变量的名字为value，它与零值比较的标准if语句如下：

if (value == 0)  

if (value != 0)

不可模仿布尔变量的风格而写成

if (value) // 会让人误解 value是布尔变量

if (!value) 

4.3.3 浮点变量与零值比较

【规则4-3-3】不可将浮点变量用“==”或“！=”与任何数字比较。

千万要留意，无论是float还是double类型的变量，都有精度限制。所以一定要避免将浮点变量用“==”或“！=”与数字比较，应该设法转化成“>=”或“<=”形式。

假设浮点变量的名字为x，应当将

if (x == 0.0)  // 隐含错误的比较

转化为

if ((x>=-EPSINON) && (x<=EPSINON))

其中EPSINON是允许的误差（即精度）。

4.3.4 指针变量与零值比较

【规则4-3-4】应当将指针变量用“==”或“！=”与NULL比较。

指针变量的零值是“空”（记为NULL）。尽管NULL的值与0相同，但是两者意义不同。假设指针变量的名字为p，它与零值比较的标准if语句如下：

if (p == NULL) // p与NULL显式比较，强调p是指针变量

if (p != NULL)

不要写成

if (p == 0) // 容易让人误解p是整型变量

if (p != 0)    

或者

if (p) // 容易让人误解p是布尔变量

if (!p)

4.3.5 对if语句的补充说明

有时候我们可能会看到 if (NULL == p) 这样古怪的格式。不是程序写错了，是程序员为了防止将 if (p == NULL) 误写成 if (p = NULL)，而有意把p和NULL颠倒。编译器认为 if (p = NULL) 是合法的，但是会指出 if (NULL = p)是错误的，因为NULL不能被赋值。

程序中有时会遇到if/else/return的组合，应该将如下不良风格的程序

if (condition)

return x;

return y;

改写为

if (condition)

{

return x;

}

else

{

return y;

}

或者改写成更加简练的

return (condition ? x : y);

4.4 循环语句的效率

C++/C循环语句中，for语句使用频率最高，while语句其次，do语句很少用。本节重点论述循环体的效率。提高循环体效率的基本办法是降低循环体的复杂性。

【建议4-4-1】在多重循环中，如果有可能，应当将最长的循环放在最内层，最短的循环放在最外层，以减少CPU跨切循环层的次数。例如示例4-4(b)的效率比示例4-4(a)的高。

 

for (row=0; row<100; row++) { for ( col=0; col<5; col++ ) { sum = sum + a[row][col]; } }

for (col=0; col<5; col++ ) { for (row=0; row<100; row++) {     sum = sum + a[row][col]; } }

　　　　　　　　　　　　　　　　　　示例4-4(a) 低效率：长循环在最外层           示例4-4(b) 高效率：长循环在最内层

【建议4-4-2】如果循环体内存在逻辑判断，并且循环次数很大，宜将逻辑判断移到循环体的外面。示例4-4(c)的程序比示例4-4(d)多执行了N-1次逻辑判断。并且由于前者老要进行逻辑判断，打断了循环“流水线”作业，使得编译器不能对循环进行优化处理，降低了效率。如果N非常大，最好采用示例4-4(d)的写法，可以提高效率。如果N非常小，两者效率差别并不明显，采用示例4-4(c)的写法比较好，因为程序更加简洁。

for (i=0; i<N; i++) { if (condition)     DoSomething(); else     DoOtherthing(); }

if (condition) { for (i=0; i<N; i++)     DoSomething(); } else {     for (i=0; i<N; i++)     DoOtherthing(); }

　　　　　　　　　　　　　　　　　　　　　　　　表4-4(c) 效率低但程序简洁                表4-4(d) 效率高但程序不简洁

4.5 for 语句的循环控制变量

【规则4-5-1】不可在for 循环体内修改循环变量，防止for 循环失去控制。

【建议4-5-1】建议for语句的循环控制变量的取值采用“半开半闭区间”写法。

示例4-5(a)中的x值属于半开半闭区间“0 =< x < N”，起点到终点的间隔为N，循环次数为N。

示例4-5(b)中的x值属于闭区间“0 =< x <= N-1”，起点到终点的间隔为N-1，循环次数为N。

相比之下，示例4-5(a)的写法更加直观，尽管两者的功能是相同的。

for (int x=0; x<N; x++) { … }

for (int x=0; x<=N-1; x++) { … }

　　　　　　　　　　　　　　　　　　　　示例4-5(a) 循环变量属于半开半闭区间           示例4-5(b) 循环变量属于闭区间

4.6 switch语句

有了if语句为什么还要switch语句？

switch是多分支选择语句，而if语句只有两个分支可供选择。虽然可以用嵌套的if语句来实现多分支选择，但那样的程序冗长难读。这是switch语句存在的理由。

switch语句的基本格式是：

switch (variable)

{

case value1 : …

break;

case value2 : …

break;

…

default :   …

break;

}

【规则4-6-1】每个case语句的结尾不要忘了加break，否则将导致多个分支重叠（除非有意使多个分支重叠）。

【规则4-6-2】不要忘记最后那个default分支。即使程序真的不需要default处理，也应该保留语句 default : break; 这样做并非多此一举，而是为了防止别人误以为你忘了default处理。

4.7 goto语句

自从提倡结构化设计以来，goto就成了有争议的语句。首先，由于goto语句可以灵活跳转，如果不加限制，它的确会破坏结构化设计风格。其次，goto语句经常带来错误或隐患。它可能跳过了某些对象的构造、变量的初始化、重要的计算等语句，例如：

goto state;

String s1, s2; // 被goto跳过

int sum = 0; // 被goto跳过

…

state:

…

如果编译器不能发觉此类错误，每用一次goto语句都可能留下隐患。

很多人建议废除C++/C的goto语句，以绝后患。但实事求是地说，错误是程序员自己造成的，不是goto的过错。goto 语句至少有一处可显神通，它能从多重循环体中咻地一下子跳到外面，用不着写很多次的break语句; 例如

{ …

{ …

{ …

goto error;

}

}

}

error:

…

就象楼房着火了，来不及从楼梯一级一级往下走，可从窗口跳出火坑。所以我们主张少用、慎用goto语句，而不是禁用。

总结：学习了基本语句与表达式就可以写简单的demo程序了。

　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　改变自己，从现在做起-----------久馆