高质量C/C++编程指南——程序的板式

---

前言

本人自毕业以来，参加工作也有两年半了。大学时期参加过很多学科竞赛并拿过奖、也帮老师做过一些项目。过程中和C语言打了很多交道，自以为是一个老手。但实际上，我甚至连熟练都算不上，才刚摸到门，编写的代码也有很多不规范的地方，比如：
1、板式混乱
2、逻辑存在严重漏洞
3、指针和地址使用方式不当。
这些都不是一名优秀的程序员该犯的错误。本人的这片文章并非完全原创，只是总结和其它大牛的经验，吸收并利用起来。
本篇文章先讲版式，版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。
可以把程序的版式比喻成“书法”。好的“书法”可以让人对程序一目了然，看得兴致勃勃。差的“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。

一、空行

空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序会多消耗一些纸张，但是值得。所以不要不舍得用空行。

规则1-1-1 在每个类声明之后、每个函数定义结束后都要加空行，参见示例代码1-1(a)。
规则1-1-2 在一个函数体内，逻辑上密切相关的语句之间不加空行其它地方应加空行分隔，参见示例代码1-1(b)。

示例1-1(a)函数之间的空行。

//空行
void Function1(...)
{
	......
}
//空行
void Function2(...)
{
	......
}
//空行
void Function3(...)
{
	......
}

示例1-1(b)函数内部的空行。

while(condition)
{
	statement1;
	//空行
	if(condition)
	{
		statement2;
	}
	else
	{
		statement3;
	}
	//空行
	statement4;
}

二、代码行

规则1-2-1 一行代码只能做意见事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便写注释。
规则1-2-2 if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少要加"{}"。这样可以防止书写失误。

示例1-2(a)风格良好的代码

/******************/
int width;  //宽度 
int height;	//高度
int depth;	//深度
/******************/
x=a+b;
y=c+d;
z=e+f;
/******************/
if(width<height)
{
	dosomething();
}
/******************/
for(init; condition; update)
{
	dosomething();
}
//空行
other();

示例1-2(b)风格不良的代码

/******************/
int width, height, depth;  //宽度 高度 深度
/******************/
x=a+b;y=c+d;z=e+f;
/******************/
if(width<height) dosomething();
/******************/
for(init; condition; update)
	dosomething();
other();

建议1-2 尽可能在定义变量的同时初始化该变量（就近原则）
如果变量的引用和其定义处相隔较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如：

int width = 114;  	//定义并初始化宽度 
int height = 514;	//定义并初始化高度
int depth = 1919;	//定义并初始化深度

三、代码内的空格

规则1-3-1 关键字后要留空格。像const、virtual、inline、case等关键字之后至少要留一个空格，否则无法辨析关键字。像if、for、while等关键字之后应留一个空额再跟左括号"("，以突出关键字。

规则1-3-2 函数名之后不要留空格，紧跟左括号“)”，以与关键字区别。

规则1-3-3 “(” 向后紧跟， “)”、“,”、“;”向前紧跟，紧跟处不留空格。

规则1-3-4 “,”之后要留空格，如Function(x, y, z)。如果“,”不是一行结束的符号，其后也要留空格，如for(init, condition, update)。

规则1-3-5 赋值操作符、比较操作符、算数操作符、逻辑操作符、位域操作符，如“=”、“+=”、“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”、“^”等二元操作符的前后应当加空格。

规则1-3-6 一元操作符如“!”、“~”、“++”、“–”、“&”（地址运算符）等前后不加空格。

规则1-3-7 像“[ ]”、“.”、“->”这类操作符前后不加空格。

建议1-3-1 对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格。
如for(i=0; i<10; i++)和if((a<=b) && (c<=d))。

示例1-3代码行内的空格

/******************/
void Func1(int x, int y, int z);	//良好的风格
void Func1(int x,int y,int z);		//不良的风格
/******************/
if(year >= 2000)		//良好的风格
if(year>=2000)			//不良的风格
if((a>=b) && (c<=d))	//良好的风格
if(a>=b&&c<=d)			//不良的风格
/******************/
for(i=0; i<10; i++)			//良好的风格
for(i=0;i<10;i++)			//不良的风格
for(i = 0; i < 10; i ++)	//过多的空格
/******************/
x = a < b ? a : b;	//良好的风格	
x=a<b?a:b;			//不良的风格
/******************/
int *x = &y;		//良好的风格	
int * x = & y;		//不良的风格
/******************/
array[5] = {0};		//不要写成array [ 5 ] = {0};
a.Status;			//不要写成a . Status;
b->Status;			//不要写成b -> Status;

四、对齐

规则1-4-1 程序的分界符“{”和“}”应独占一行并且位于同一列，同时与引用它们的语句对齐。

规则1-4-2 “{}”之内的代码块在“{”右边数格处对齐。

示例1-4(a)风格良好的对齐

/******************/
void Function(int x)
{
	...//program code
}
/******************/
if(condition)
{
	...//program code
}
else
{
	...//program code
}
/******************/
for(init; condition; update)
{
	...//program code
}
/******************/
while(condition)
{
	...//program code
}
/******************/
如果出现嵌套{}，则使用缩进对齐，如：
{
	...
	{
		...
	}
	...
}

示例1-4(b)风格不良的对齐

/******************/
void Function(int x)
{
	...//program code
}
/******************/
if(condition)
{
	...//program code
}
else
{
	...//program code
}
/******************/
for(init; condition; update)
{
	...//program code
}
/******************/
while(condition)
{
	...//program code
}
/******************/
如果出现嵌套{}，则使用缩进对齐，如：
{
	...
	{
		...
	}
	...
}

五、长行拆分

规则1-5-1 代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。
规则1-5-2 长表达式要在低优先级操作符处拆分新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。

示例1-5长行的拆分

/******************/
if((very_longer_variable1 >= very_longer_variable2)
	&& (very_longer_variable3 <= very_longer_variable4)
	&& (very_longer_variable5 <= very_longer_variable6))
{
	dosomething();
}
/******************/
Virtual CMatrix CMultiplyMatrix(CMatrix leftMatrix,
								CMatrix rightMatrix);
/******************/
for(very_longer_initialization;
	very_longer_condition;
	very_longer_update)
{
	dosomething();
}

六、修饰符的位置

修饰符 * 和 & 应该靠近数据类型还是靠近变量名，是个有争议的话题。
若将修饰符 * 靠近数据类型，例如：int* x;从语义上讲此写法比较直观，即x是int类型的指针。
上述写法的弊端是容易引起误解，例如：int* x,y;此处y容易被误解为指针变量。虽然将x和y分行定义可以避免误解，但并不是人人都愿意这样做。

规则1-6-1 应当将修饰符 * 和 & 紧靠变量名
例如：

char *name;
int *x, y;	//此处y不会被误认为指针

七、注释

注释通常用于：
（1）版本、版权声明；
（2）函数接口说明；
（3）重要的代码行或段落提示。
虽然注释有助于理解代码，但注意不可过多地使用注释。参加示例1-7

规则1-7-1 注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多会让人眼花缭乱。注释的花样要少。

规则1-7-2 如果代码本来就是清楚的，则不必加注释。否则会多此一举，令人厌烦
例如：
i++; //i加1
多余的注释……

规则1-7-3 边写代码边注释，修改代码的同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

规则1-7-4 注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。，

规则1-7-5 尽量避免在注释中使用缩写，特别是不常用的缩写 。

规则1-7-6 注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。

规则1-7-7 当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。

示例1-7程序的注释

/*
*函数介绍：
*输入参数：
*输出参数：
*返回值：
*/
void Function(float x, float y, float z)
{
	if(...)
	{
		...
		while(...)
		{
			...
		}//end of while
	}//end of if
}

八、类的板式

类可以将数据和函数封装在一起，其中函数表示类的行为（或称服务）。类提供关键字public、protected和private，分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的，既让类仅仅公开必须要让外界知道的内容，而隐藏其它一切内容。我们不可以滥用类的封装功能，不要把它当成火锅，什么东西都往里扔。
类的版式主要有两种方式：
（一）将private类型的数据写在前面，而将public类型的函数写在后面，如示例1-8(a)，采用这种版式的程序员主张类的设计“以数据为中心”，重点关注类的内部结构。
（二）将public类型的函数写在前面，而将private类型的函数写在后面，如示例1-8(b)，采用这种版式的程序员主张类的设计“以行为为中心”，重点关注的是类应该提供什么样的接口（或服务）。
很多C++教科书受到Biarne Stroustrup第一本著作的影响，不知不觉地采用了“以数据为中心”的书写方法，并不见得有多少道理。
本人建议采用“以行为为中心”的书写方式，即首先考虑类应该提供什么样的函数。这是很多人的经验——“这样做不仅让自己在设计类时思路清晰，而且方便别人阅读。因为用户最关心的是接口，谁愿意看到一堆私有数据成员呢？”

示例1-8(a)以数据为中心的版式

class A
{
	private:
	int i, j;
	float x, y;
	...
	public:
	void Fun1(void);
	void Fun2(void);
	...
}

示例1-8(b)以行为为中心的版式

class A
{
	public:
	void Fun1(void);
	void Fun2(void);
	...
	private:
	int i, j;
	float x, y;
	...
}