高質量C++/C編程指南[2]

 
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-2if、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第一本著作的影響,不知不覺地採用了“以數據爲中心”的書寫方式,並不見得有多少道理。
我建議讀者採用“以行爲爲中心”的書寫方式,即首先考慮類應該提供什麼樣的函數。這是很多人的經驗——“這樣做不僅讓自己在設計類時思路清晰,而且方便別人閱讀。因爲用戶最關心的是接口,誰願意先看到一堆私有數據成員!”
 
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) 以數據中心版式                 示例8.3(b) 以行爲爲中心的版式
 
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章