第2章 程序的版式
版式雖然不會(huì)影響程序的功能，但會(huì)影響可讀性。程序的版式追求清晰、美觀，是程序風(fēng)格的重要構(gòu)成因素。
可以把程序的版式比喻為“書法”。好的“書法”可讓人對程序一目了然，看得興致勃勃。差的程序“書法”如螃蟹爬行，讓人看得索然無味，更令維護(hù)者煩惱有加。請程序員們學(xué)習(xí)程序的“書法”，彌補(bǔ)大學(xué)計(jì)算機(jī)教育的漏洞，實(shí)在很有必要。
空行起著分隔程序段落的作用。空行得體（不過多也不過少）將使程序的布局更加清晰。空行不會(huì)浪費(fèi)內(nèi)存，雖然打印含有空行的程序是會(huì)多消耗一些紙張，但是值得。所以不要舍不得用空行。
l
【規(guī)則2-1-1】在每個(gè)類聲明之后、每個(gè)函數(shù)定義結(jié)束之后都要加空行。參見示例2-1（a）
l
【規(guī)則2-1-2】在一個(gè)函數(shù)體內(nèi)，邏揖上密切相關(guān)的語句之間不加空行，其它地方應(yīng)加空行分隔。參見示例2-1（b ）
|
// 空行
void Function1(…)
{
…
}
// 空行
void Function2(…)
{
…
}
// 空行
void Function3(…)
{
…
}
|
//
空行
while
(condition)
{
statement1;
// 空行
if (condition)
{
statement2;
}
else
{
statement3;
}
//
空行
statement4;
}
|
示例2-1(a) 函數(shù)之間的空行 示例2-1(b) 函數(shù)內(nèi)部的空行
l
【規(guī)則2-2-1】一行代碼只做一件事情，如只定義一個(gè)變量，或只寫一條語句。這樣的代碼容易閱讀，并且方便于寫注釋。
l
【規(guī)則2-2-2】if、for、while、do等語句自占一行，執(zhí)行語句不得緊跟其后。不論執(zhí)行語句有多少都要加{}。這樣可以防止書寫失誤。
示例2-2（a）為風(fēng)格良好的代碼行，示例2-2（b）為風(fēng)格不良的代碼行。
|
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) 風(fēng)格良好的代碼行 示例2-2(b)
風(fēng)格不良的代碼行
²
【建議2-2-1】盡可能在定義變量的同時(shí)初始化該變量（就近原則）
如果變量的引用處和其定義處相隔比較遠(yuǎn)，變量的初始化很容易被忘記。如果引用了未被初始化的變量，可能會(huì)導(dǎo)致程序錯(cuò)誤。本建議可以減少隱患。例如
int width = 10; // 定義并初紿化width
int height = 10; // 定義并初紿化height
int depth = 10; //
定義并初紿化depth
2.3 代碼行內(nèi)的空格
l
【規(guī)則2-3-1】關(guān)鍵字之后要留空格。象const、virtual、inline、case 等關(guān)鍵字之后至少要留一個(gè)空格，否則無法辨析關(guān)鍵字。象if、for、while等關(guān)鍵字之后應(yīng)留一個(gè)空格再跟左括號(hào)‘（’，以突出關(guān)鍵字。
l
【規(guī)則2-3-2】函數(shù)名之后不要留空格，緊跟左括號(hào)‘（’，以與關(guān)鍵字區(qū)別。
l
【規(guī)則2-3-3】‘（’向后緊跟，‘）’、‘，’、‘;’向前緊跟，緊跟處不留空格。
l
【規(guī)則2-3-4】‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的結(jié)束符號(hào)，其后要留空格，如for (initialization; condition; update)。
l
【規(guī)則2-3-5】賦值操作符、比較操作符、算術(shù)操作符、邏輯操作符、位域操作符，如“=”、“+=”
“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后應(yīng)當(dāng)加空格。
l
【規(guī)則2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”（地址運(yùn)算符）等前后不加空格。
l
【規(guī)則2-3-7】象“［］”、“.”、“->”這類操作符前后不加空格。
²
【建議2-3-1】對于表達(dá)式比較長的for語句和if語句，為了緊湊起見可以適當(dāng)?shù)厝サ粢恍┛崭瘢?/span>for (i=0; i<10; i++)和if ((a<=b) &&
(c<=d))
|
void Func1(int x,
int y, int z); // 良好的風(fēng)格
void Func1 (int
x,int y,int z); //
不良的風(fēng)格
|
|
if (year >=
2000) // 良好的風(fēng)格
if(year>=2000) // 不良的風(fēng)格
if ((a>=b)
&& (c<=d))
// 良好的風(fēng)格
if(a>=b&&c<=d) // 不良的風(fēng)格
|
|
for (i=0; i<10;
i++) // 良好的風(fēng)格
for(i=0;i<10;i++) // 不良的風(fēng)格
for (i = 0; I <
10; i ++) // 過多的空格
|
|
x = a < b ? a :
b; // 良好的風(fēng)格
x=a<b?a:b; // 不好的風(fēng)格
|
|
int *x =
&y; //
良好的風(fēng)格
int * x = &
y; // 不良的風(fēng)格
|
|
array[5] = 0; // 不要寫成 array [ 5 ] = 0;
a.Function(); // 不要寫成 a . Function();
b->Function(); // 不要寫成 b -> Function();
|
示例2-3 代碼行內(nèi)的空格
l
【規(guī)則2-4-1】程序的分界符‘{’和‘}’應(yīng)獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語句左對齊。
l
【規(guī)則2-4-2】{ }之內(nèi)的代碼塊在‘{’右邊數(shù)格處左對齊。
示例2-4（a）為風(fēng)格良好的對齊，示例2-4（b）為風(fēng)格不良的對齊。
|
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
}
|
|
如果出現(xiàn)嵌套的｛｝，則使用縮進(jìn)對齊，如：
{
…
{
…
}
…
}
|
|
示例2-4(a) 風(fēng)格良好的對齊 示例2-4(b) 風(fēng)格不良的對齊
l
【規(guī)則2-5-1】代碼行最大長度宜控制在70至80個(gè)字符以內(nèi)。代碼行不要過長，否則眼睛看不過來，也不便于打印。
l
【規(guī)則2-5-2】長表達(dá)式要在低優(yōu)先級操作符處拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語句可讀。
|
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 修飾符的位置
修飾符
* 和 ＆ 應(yīng)該靠近數(shù)據(jù)類型還是該靠近變量名，是個(gè)有爭議的活題。
若將修飾符 * 靠近數(shù)據(jù)類型，例如：int* x; 從語義上講此寫法比較直觀，即x是int 類型的指針。
上述寫法的弊端是容易引起誤解，例如：int* x, y; 此處y容易被誤解為指針變量。雖然將x和y分行定義可以避免誤解，但并不是人人都愿意這樣做。
l
【規(guī)則2-6-1】應(yīng)當(dāng)將修飾符 * 和 ＆ 緊靠變量名
例如：
char *name;
int
*x, y; // 此處y不會(huì)被誤解為指針
C語言的注釋符為“/*…*/”。C++語言中，程序塊的注釋常采用“/*…*/”，行注釋一般采用“//…”。注釋通常用于：
（1）版本、版權(quán)聲明；
（2）函數(shù)接口說明；
（3）重要的代碼行或段落提示。
雖然注釋有助于理解代碼，但注意不可過多地使用注釋。參見示例2-6。
l
【規(guī)則2-7-1】注釋是對代碼的“提示”，而不是文檔。程序中的注釋不可喧賓奪主，注釋太多了會(huì)讓人眼花繚亂。注釋的花樣要少。
l
【規(guī)則2-7-2】如果代碼本來就是清楚的，則不必加注釋。否則多此一舉，令人厭煩。例如
i++; //
i 加 1，多余的注釋
l
【規(guī)則2-7-3】邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除。
l
【規(guī)則2-7-4】注釋應(yīng)當(dāng)準(zhǔn)確、易懂，防止注釋有二義性。錯(cuò)誤的注釋不但無益反而有害。
l
【規(guī)則2-7-5】盡量避免在注釋中使用縮寫，特別是不常用縮寫。
l
【規(guī)則2-7-6】注釋的位置應(yīng)與被描述的代碼相鄰，可以放在代碼的上方或右方，不可放在下方。
l
【規(guī)則2-7-8】當(dāng)代碼比較長，特別是有多重嵌套時(shí)，應(yīng)當(dāng)在一些段落的結(jié)束處加注釋，便于閱讀。
|
/*
* 函數(shù)介紹：
* 輸入?yún)?shù)：
* 輸出參數(shù)：
* 返回值 ：
*/
void Function(float x, float y, float z)
{
…
}
|
if (…)
{
…
while (…)
{
…
} // end of while
…
} // end of if
|
示例2-6 程序的注釋
類可以將數(shù)據(jù)和函數(shù)封裝在一起，其中函數(shù)表示了類的行為（或稱服務(wù)）。類提供關(guān)鍵字public、protected和private，分別用于聲明哪些數(shù)據(jù)和函數(shù)是公有的、受保護(hù)的或者是私有的。這樣可以達(dá)到信息隱藏的目的，即讓類僅僅公開必須要讓外界知道的內(nèi)容，而隱藏其它一切內(nèi)容。我們不可以濫用類的封裝功能，不要把它當(dāng)成火鍋，什么東西都往里扔。
類的版式主要有兩種方式：
（1）將private類型的數(shù)據(jù)寫在前面，而將public類型的函數(shù)寫在后面，如示例8-3（a）。采用這種版式的程序員主張類的設(shè)計(jì)“以數(shù)據(jù)為中心”，重點(diǎn)關(guān)注類的內(nèi)部結(jié)構(gòu)。
（2）將public類型的函數(shù)寫在前面，而將private類型的數(shù)據(jù)寫在后面，如示例8.3（b）采用這種版式的程序員主張類的設(shè)計(jì)“以行為為中心”，重點(diǎn)關(guān)注的是類應(yīng)該提供什么樣的接口（或服務(wù)）。
很多C++教課書受到Biarne
Stroustrup第一本著作的影響，不知不覺地采用了“以數(shù)據(jù)為中心”的書寫方式，并不見得有多少道理。
我建議讀者采用“以行為為中心”的書寫方式，即首先考慮類應(yīng)該提供什么樣的函數(shù)。這是很多人的經(jīng)驗(yàn)——“這樣做不僅讓自己在設(shè)計(jì)類時(shí)思路清晰，而且方便別人閱讀。因?yàn)橛脩糇铌P(guān)心的是接口，誰愿意先看到一堆私有數(shù)據(jù)成員！”
|
class A
{
private:
int i, j;
float x, y;
…
public:
void
Func1(void);
void
Func2(void);
…
}
|
class A
{
public:
void
Func1(void);
void
Func2(void);
…
private:
int i, j;
float x, y;
…
}
|
示例8.3(a) 以數(shù)據(jù)為中心版式
示例8.3(b) 以行為為中心的版式
