[ 永遠的UNIX::UNIX技術資料的寶庫 ]   GB | BIG5

首頁 > 編程技術 > C/C++ > 正文
高質量C++/C編程指南 -- 第2章 程序的版式
本文出自: 作者: 林銳 博士 (2002-07-12 06:02:00)

2 程序的版式

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

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

2.1 空行

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

 

l         【規則2-1-1在每個類聲明之、每個函數定義結束之都要加空行。參見示例2-1a

l         【規則2-1-2在一個函數體內,邏揖上密切相關的語句之間不加空行,其它地方應加空行分隔。參見示例2-1b

 

// 空行

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-2ifforwhiledo等語句自佔一行,執行語句不得緊跟其。不論執行語句有多少都要加{}。這樣可以防止書寫失誤。

 

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

 

 

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關鍵字之要留空格。象constvirtualinlinecase 等關鍵字之至少要留一個空格,否則無法辨析關鍵字。象ifforwhile等關鍵字之應留一個空格再跟左括號‘(’,以突出關鍵字。

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-4a)為風格良好的對齊,示例2-4b)為風格不良的對齊。

 

 

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代碼行最大長度宜控制在7080個字符以內。代碼行不要過長,否則眼睛看不過來,也不便打印。

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();

}

http://www.fanqiang.com)     進入【UNIX論壇


相關文章
高質量C++/C編程指南 -- 第1章 文件結構 (2002-07-11 06:02:01)
高質量C++/C編程指南 -- 前言 (2002-07-10 06:02:01)
 

★  樊強制作 歡迎分享  ★