第2章 程序的版式

       版式雖然不會影響程序的功能，但會影響可讀性。程序的版式追求清晰、美觀，是程序風格的重要構成因素。

可以把程序的版式比喻為“書法”。好的“書法”可讓人對程序一目了然，看得興致勃勃。差的程序“書法”如螃蟹爬行，讓人看得索然無味，更令維護者煩惱有加。請程序員們學習程序的“書法”，彌補大學計算機教育的漏洞，實在很有必要。

2.1 空行

空行起著分隔程序段落的作用。空行得體（不過多也不過少）將使程序的布局更加清晰。空行不會浪費內(nèi)存，雖然打印含有空行的程序是會多消耗一些紙張，但是值得。所以不要舍不得用空行。

l         【規(guī)則2-1-1】在每個類聲明之后、每個函數(shù)定義結束之后都要加空行。參見示例2-1（a）

l         【規(guī)則2-1-2】在一個函數(shù)體內(nèi)，邏揖上密切相關的語句之間不加空行，其它地方應加空行分隔。參見示例2-1（b ）

示例2-1(a) 函數(shù)之間的空行                   示例2-1(b) 函數(shù)內(nèi)部的空行

2.2 代碼行

l         【規(guī)則2-2-1】一行代碼只做一件事情，如只定義一個變量，或只寫一條語句。這樣的代碼容易閱讀，并且方便于寫注釋。

l         【規(guī)則2-2-2】if、for、while、do等語句自占一行，執(zhí)行語句不得緊跟其后。不論執(zhí)行語句有多少都要加{}。這樣可以防止書寫失誤。

示例2-2（a）為風格良好的代碼行，示例2-2（b）為風格不良的代碼行。

示例2-2(a) 風格良好的代碼行                 示例2-2(b) 風格不良的代碼行

²        【建議2-2-1】盡可能在定義變量的同時初始化該變量（就近原則）

如果變量的引用處和其定義處相隔比較遠，變量的初始化很容易被忘記。如果引用了未被初始化的變量，可能會導致程序錯誤。本建議可以減少隱患。例如

int width = 10;     // 定義并初紿化width

int height = 10;    // 定義并初紿化height

int depth = 10;     // 定義并初紿化depth

2.3 代碼行內(nèi)的空格

l         【規(guī)則2-3-1】關鍵字之后要留空格。象const、virtual、inline、case 等關鍵字之后至少要留一個空格，否則無法辨析關鍵字。象if、for、while等關鍵字之后應留一個空格再跟左括號‘（’，以突出關鍵字。

l         【規(guī)則2-3-2】函數(shù)名之后不要留空格，緊跟左括號‘（’，以與關鍵字區(qū)別。

l         【規(guī)則2-3-3】‘（’向后緊跟，‘）’、‘，’、‘;’向前緊跟，緊跟處不留空格。

l         【規(guī)則2-3-4】‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的結束符號，其后要留空格，如for (initialization; condition; update)。

l         【規(guī)則2-3-5】賦值操作符、比較操作符、算術操作符、邏輯操作符、位域操作符，如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后應當加空格。

l         【規(guī)則2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”（地址運算符）等前后不加空格。

l         【規(guī)則2-3-7】象“［］”、“.”、“->”這類操作符前后不加空格。

²        【建議2-3-1】對于表達式比較長的for語句和if語句，為了緊湊起見可以適當?shù)厝サ粢恍┛崭瘢?/span>for (i=0; i<10; i++)和if ((a<=b) && (c<=d))

示例2-3 代碼行內(nèi)的空格

2.4 對齊

l         【規(guī)則2-4-1】程序的分界符‘{’和‘}’應獨占一行并且位于同一列，同時與引用它們的語句左對齊。

l         【規(guī)則2-4-2】{ }之內(nèi)的代碼塊在‘{’右邊數(shù)格處左對齊。

示例2-4（a）為風格良好的對齊，示例2-4（b）為風格不良的對齊。

示例2-4(a) 風格良好的對齊                       示例2-4(b) 風格不良的對齊

2.5 長行拆分

l         【規(guī)則2-5-1】代碼行最大長度宜控制在70至80個字符以內(nèi)。代碼行不要過長，否則眼睛看不過來，也不便于打印。

l         【規(guī)則2-5-2】長表達式要在低優(yōu)先級操作符處拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要進行適當?shù)目s進，使排版整齊，語句可讀。

                                          示例2-5 長行的拆分

2.6 修飾符的位置

修飾符 * 和 ＆ 應該靠近數(shù)據(jù)類型還是該靠近變量名，是個有爭議的活題。

若將修飾符 * 靠近數(shù)據(jù)類型，例如：int*  x; 從語義上講此寫法比較直觀，即x是int 類型的指針。

上述寫法的弊端是容易引起誤解，例如：int*  x, y; 此處y容易被誤解為指針變量。雖然將x和y分行定義可以避免誤解，但并不是人人都愿意這樣做。

l         【規(guī)則2-6-1】應當將修飾符 * 和 ＆ 緊靠變量名

例如：

char  *name;

    int   *x, y;    // 此處y不會被誤解為指針

2.7 注釋

C語言的注釋符為“/*…*/”。C++語言中，程序塊的注釋常采用“/*…*/”，行注釋一般采用“//…”。注釋通常用于：

（1）版本、版權聲明；

（2）函數(shù)接口說明；

（3）重要的代碼行或段落提示。

雖然注釋有助于理解代碼，但注意不可過多地使用注釋。參見示例2-6。

l         【規(guī)則2-7-1】注釋是對代碼的“提示”，而不是文檔。程序中的注釋不可喧賓奪主，注釋太多了會讓人眼花繚亂。注釋的花樣要少。

l         【規(guī)則2-7-2】如果代碼本來就是清楚的，則不必加注釋。否則多此一舉，令人厭煩。例如

i++;    // i 加 1，多余的注釋

l         【規(guī)則2-7-3】邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。

l         【規(guī)則2-7-4】注釋應當準確、易懂，防止注釋有二義性。錯誤的注釋不但無益反而有害。

l         【規(guī)則2-7-5】盡量避免在注釋中使用縮寫，特別是不常用縮寫。

l         【規(guī)則2-7-6】注釋的位置應與被描述的代碼相鄰，可以放在代碼的上方或右方，不可放在下方。

l         【規(guī)則2-7-8】當代碼比較長，特別是有多重嵌套時，應當在一些段落的結束處加注釋，便于閱讀。

                                       示例2-6 程序的注釋

2.8 類的版式

類可以將數(shù)據(jù)和函數(shù)封裝在一起，其中函數(shù)表示了類的行為（或稱服務）。類提供關鍵字public、protected和private，分別用于聲明哪些數(shù)據(jù)和函數(shù)是公有的、受保護的或者是私有的。這樣可以達到信息隱藏的目的，即讓類僅僅公開必須要讓外界知道的內(nèi)容，而隱藏其它一切內(nèi)容。我們不可以濫用類的封裝功能，不要把它當成火鍋，什么東西都往里扔。

類的版式主要有兩種方式：

（1）將private類型的數(shù)據(jù)寫在前面，而將public類型的函數(shù)寫在后面，如示例8-3（a）。采用這種版式的程序員主張類的設計“以數(shù)據(jù)為中心”，重點關注類的內(nèi)部結構。

（2）將public類型的函數(shù)寫在前面，而將private類型的數(shù)據(jù)寫在后面，如示例8.3（b）采用這種版式的程序員主張類的設計“以行為為中心”，重點關注的是類應該提供什么樣的接口（或服務）。

很多C++教課書受到Biarne Stroustrup第一本著作的影響，不知不覺地采用了“以數(shù)據(jù)為中心”的書寫方式，并不見得有多少道理。

我建議讀者采用“以行為為中心”的書寫方式，即首先考慮類應該提供什么樣的函數(shù)。這是很多人的經(jīng)驗——“這樣做不僅讓自己在設計類時思路清晰，而且方便別人閱讀。因為用戶最關心的是接口，誰愿意先看到一堆私有數(shù)據(jù)成員！”

示例8.3(a) 以數(shù)據(jù)為中心版式                                                     示例8.3(b) 以行為為中心的版式