第2章 步调的版式
版式虽然不会影响步调的成效，但会影响可读性。步调的版式追求明晰、美观，是步调作风的严峻构成要素。
可以把步调的版式比方为“书法”。好的“书法”可让人对步调管窥蠡测，看得心花怒放。差的步调“书法”如螃蟹匍匐，让人看得死板幽默，更令维护者懊恼有加。请步调员们学习步调的“书法”，填补大学角力计算图论机指点的坏处，真实很有需求。
2.1 空行
空行起着分开步调段落的浸染。空行得体（不过多也不过少）将使步调的布局愈加明晰。空行不会浪费内存，虽然打印含有空行的步调是会多消耗一些纸张，但是值得。所以不要舍不得用空行。
l 【纪律2-1-1】在每个类声明之后、每个函数定义终了之后都要加空行。拜见教例2-1（a）
l 【纪律2-1-2】在一个函数体内，逻揖上紧密亲近相干的语句之间不加空行，其余中间应加空行分开。拜见教例2-1（b ）
// 空行
void Function1(…)
{
…
}
// 空行
void Function2(…)
{
…
}
// 空行
void Function3(…)
{
…
}
// 空行
while (condition)
{
statement1;
// 空行
if (condition)
{
statement2;
}
else
{
statement3;
}
// 空行
statement4;
}
示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行
2.2 代码行
l 【纪律2-2-1】一行代码只做一件事项，如只定义一个变量，或只写一条语句。如许的代码随意轻率阅读，而且方便于写讲明。
l 【纪律2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟后来。不管执行语句有几许都要加{}。如答应以制止誊写失误。
示例2-2（a）为作风精彩的代码行，示例2-2（b）为作风不良的代码行。
int width; // 宽度
int height; // 高度
int depth; // 深度
int width, height, depth; // 宽度高度深度
x = a b;
y = c d;
z = e f;
X ＝ a b; y = c d; z = e f;
if (width < height)
{
dosomething();
}
if (width < height) dosomething();
for (initialization; condition; update)
{
dosomething();
}
// 空行
other();
for (initialization; condition; update)
dosomething();
other();
示例2-2(a) 作风精彩的代码行 示例2-2(b) 作风不良的代码行
² 【倡议2-2-1】尽也许在定义变量的同时初始化该变量（就近准绳）
要是变量的引用处和其定义处相隔比较远，变量的初始化很随意轻率被忘记。要是引用了未被初始化的变量，也许会招致步调错误。本倡议可以添加隐患。比方
int width = 10; // 定义并初绐化width
int height = 10; // 定义并初绐化height
int depth = 10; // 定义并初绐化depth
2.3 代码行内的空格
l 【纪律2-3-1】枢纽字之后要留空格。象const、virtual、inline、case 等枢纽字之后至多要留一个空格，不然无法辨析枢纽字。象if、for、while等枢纽字之后应留一个空格再跟左括号‘（’，以突出枢纽字。
l 【纪律2-3-2】函数名之后不要留空格，紧跟左括号‘（’，以与枢纽字区别。
l 【纪律2-3-3】‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。
l 【纪律2-3-4】‘，’之后要留空格，如Function(x, y, z)。要是‘;’不是一行的终了标志，后来要留空格，如for (initialization; condition; update)。
l 【纪律2-3-5】赋值操纵符、比较操纵符、算术操纵符、逻辑操纵符、位域操纵符，如“=”、“ =” “>=”、“<=”、“ ”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操纵符的前后应当加空格。
l 【纪律2-3-6】一元操纵符如“!”、“~”、“ ”、“--”、“&”（所在运算符）等前后不加空格。
l 【纪律2-3-7】象“［］”、“.”、“->”这类操纵符前后不加空格。
² 【倡议2-3-1】关于表达式比较长的for语句和if语句，为了紧凑起见可以适外地去失一些空格，如for (i=0; i<10; i )和if ((a<=b) && (c<=d))
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.Function(); // 不要写成 a . Function();
b->Function(); // 不要写成 b -> Function();
示例2-3 代码行内的空格
2.4 对齐
l 【纪律2-4-1】步调的分界符‘{’和‘}’应独占一行而且位于统一列，同时与引用它们的语句左对齐。
l 【纪律2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。
示例2-4（a）为作风精彩的对齐，示例2-4（b）为作风不良的对齐。
void Function(int x)
{
… // program code
}
void Function(int x){
… // program code
}
if (condition)
{
… // program code
}
else
{
… // program code
}
if (condition){
… // program code
}
else {
… // program code
}
for (initialization; condition; update)
{
… // program code
}
for (initialization; condition; update){
… // program code
}
While (condition)
{
… // program code
}
while (condition){
… // program code
}
要是呈现嵌套的｛｝，则使用缩进对齐，如：
{
…
{
…
}
…
}
示例2-4(a) 作风精彩的对齐 示例2-4(b) 作风不良的对齐
2.5 长行拆分
l 【纪律2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，不然眼睛看不过来，也方便于打印。
l 【纪律2-5-2】长表达式要在低优先级操纵符处拆分红新行，操纵符放在新行之首（以便突出操纵符）。拆分出的新行要举办适当的缩进，使排版整洁，语句可读。
if ((very_longer_variable1 >= very_longer_variable12)
&& (very_longer_variable3 <= very_longer_variable14)
&& (very_longer_variable5 <= very_longer_variable16))
{
dosomething();
}
virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix,
CMatrix rightMatrix);
for (very_longer_initialization;
very_longer_condition;
very_longer_update)
{
dosomething();
}
示例2-5 长行的拆分
2.6 修饰符的地位
修饰符 * 和 ＆ 应该接近数据范例照旧该接近变量名，是个有争议的活题。
若将修饰符 * 接近数据范例，比方：int* x; 从语义上讲此写法比较直观，即x是int 范例的指针。
上述写法的优点是随意轻率惹起误解，比方：int* x, y; 此处y随意轻率被误解为指针变量。虽然将x和y分行定义可以制止误解，但并不是人人都甘愿宁肯如许做。
l 【纪律2-6-1】应当将修饰符 * 和 ＆ 紧靠变量名
比方：
char *name;
int *x, y; // 此处y不会被误解为指针
2.7 讲明
C言语的讲明符为“/*…*/”。C 言语中，步调块的讲明常给与“/*…*/”，行讲明粗浅给与“//…”。讲明往往用于：
（1）版本、版权声明；
（2）函数接口申明；
（3）严峻的代码行或段落提醒。
虽然讲明有助于懂得代码，但看重弗成过多地使用讲明。拜见教例2-6。
l 【纪律2-7-1】讲明是对代码的“提醒”，而不是文档。步调中的讲明弗成喧宾夺主，讲明太多了会让人目眩狼籍。讲明的格局要少。
l 【纪律2-7-2】要是代码原来便是懂得的，则不必加讲明。不然添枝加叶，令人厌恶。比方
i ; // i 加 1，多余的讲明
l 【纪律2-7-3】边写代码边讲明，修改代码同时修改相应的讲明，以包管讲明与代码的不同性。不再有效的讲明要删除。
l 【纪律2-7-4】讲明应当正确、易懂，制止讲明有二义性。错误的讲明不只无益反而有害。
l 【纪律2-7-5】只管制止在讲明中使用缩写，稀罕是不常用缩写。
l 【纪律2-7-6】讲明的地位应与被描绘的代码相邻，可以放在代码的上方或右方，弗成放在下方。
l 【纪律2-7-8】古代码比较长，稀罕是有多重嵌套时，应当在一些段落的终了处加讲明，便于阅读。
/*
* 函数引见：
* 输出参数：
* 输出参数：
* 前往值 ：
*/
void Function(float x, float y, float z)
{
…
}
if (…)
{
…
while (…)
{
…
} // end of while
…
} // end of if
示例2-6 步调的讲明
2.8 类的版式
类可以将数据和函数封装在一同，其中函数表示了类的举动（或称效能）。类供应枢纽字public、protected和private，辨别用于声明哪些数据和函数是私有的、受保护的或许是私有的。如答应以到达信息藏匿的目的，即让类仅仅果真必需求让外界晓得的内容，而藏匿其余统统内容。我们弗成以滥用类的封装成效，不要把它当成火锅，什么对象都往里扔。
类的版式主要有两种体式名目：
（1）将private范例的数据写在后面，而将public范例的函数写在后面，如示例8-3（a）。给与这种版式的步调员主张类的方案“以数据为中间”，重点关注类的内部布局。
（2）将public范例的函数写在后面，而将private范例的数据写在后面，如示例8.3（b）给与这种版式的步调员主张类的方案“以举动为中间”，重点关注的是类应该供应什么样的接口（或效能）。
许多C 教课书遭到Biarne Stroustrup第一本著作的影响，不知不觉地给与了“以数据为中间”的誊写体式名目，并不见得有几许道理。
我倡议读者给与“以举动为中间”的誊写体式名目，即起首思索类应该供应什么样的函数。这是许多人的阅历——“如许做不只让本人在方案类时思路明晰，而且方便他人阅读。因为用户最关心的是接口，谁甘愿宁肯先看到一堆私有数据成员！”
>
{
private:
int i, j;
float x, y;
…
public:
void Func1(void);
void Func2(void);
…
}
>
{
public:
void Func1(void);
void Func2(void);
…
private:
int i, j;
float x, y;
…
}
示例8.3(a) 以数据为中间版式 示例8.3(b) 以举动为中间的版式
版权声明： 原创作品，答应转载，转载时请务必以超链接情势标明文章 原始来由 、作者信息和本声明。不然将清查法律责任。
