編程風格雖然不會影響程序的功能,但會影響可讀性。程序的版式追求清晰、美觀,是程序風格的重要構成因素。
1. 空行
空行起着分隔程序段落的作用。空行得體(不能過多也不能過少)將使程序的佈局更加清晰。空行不會浪費內存,雖然打印含有空行的程序是會多消耗一些紙張,但是值得。所以不要捨不得用空行。
¯ 在每個類聲明之後、每個函數定義結束之後都要加空行。例如:
//類定義之後要用空格 class Date{ public: Date(int x, int y, int z); ~Date(); void Show(); private: int year; int month; int day; }; //空行 class Time{ ......
|
Date::Date(int x, int y, int z) { year = x; month = y; day = z; } //空行 Date::~Date() { } //空行 void Date::Show() { cout<<year<<"-"<<month<<"-"<<day<<endl; } |
2. 代碼行
¯ 一行代碼只做一件事情,如只定義一個變量,或只寫一條語句。這樣的代碼容易閱讀,並且方便於寫註釋。
¯ if、for、while、do等語句自佔一行,執行語句不得緊跟其後。不論執行語句有多少都要加{}(建議最好這樣,不要怕麻煩)。這樣可以防止書寫失誤。
¯ 儘可能在定義變量的同時初始化該變量(就近原則)
如果變量的引用處和其定義處相隔比較遠,變量的初始化很容易被忘記。如果引用了未被初始化的變量,可能會導致程序錯誤。本建議可以減少隱患。例如
int width = 10; // 定義並初紿化width
char *name = new char[10]; //直接申請空間,而不至於出現未給指針變量指向空間的錯誤
3. 代碼行內的空格
¯ 關鍵字之後要留空格。像const、virtual、inline、case 等關鍵字之後至少要留一個空格,否則無法辨析關鍵字。像if、for、while等關鍵字之後可以留一個空格再跟左括號‘(’,以突出關鍵字。
¯ 函數名之後不要留空格,緊跟左括號‘(’,以與關鍵字區別。
¯ ‘(’向後緊跟,‘)’、‘,’、‘;’向前緊跟,緊跟處不留空格。
¯ ‘,’之後要留空格,如Function(x, y, z)。如果‘;’不是一行的結束符號,其後要留空格,如for (initialization; condition; update)。
¯ 賦值操作符、比較操作符、算術操作符、邏輯操作符、位域操作符,如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前後應當加空格。
¯ 一元操作符如“!”、“~”、“++”、“--”、“&”(地址運算符)等前後不加空格。
¯ 像“[]”、“.”、“->”這類操作符前後不加空格。
¯ 對於表達式比較長的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(); |
4. 對齊
¯ 程序的分界符‘{’和‘}’應獨佔一行並且位於同一列,同時與引用它們的語句左對齊。
¯ { }之內的代碼塊在‘{’右邊數格處左對齊。(建議採用VC++6.0建議的默認風格)
5. 長行拆分
¯ 代碼行最大長度宜控制在70至80個字符以內。代碼行不要過長,否則眼睛看不過來,也不便於打印。
¯ 長表達式要在低優先級操作符處拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要進行適當的縮進,使排版整齊,語句可讀。
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(); } |
6. 修飾符的位置
¯ 應當將修飾符 * 和 & 緊靠變量名
例如:
char *name;
int *x, y; // 此處y不會被誤解爲指針
7. 註釋
C語言的註釋符爲“/*…*/”。C++語言中,程序塊的註釋常採用“/*…*/”,行註釋一般採用“//…”。註釋通常用於:
(1)版本、版權聲明;
(2)函數接口說明;
(3)重要的代碼行或段落提示。
雖然註釋有助於理解代碼,但注意不可過多地使用註釋。
¯ 註釋是對代碼的“提示”,而不是文檔。程序中的註釋不可喧賓奪主,註釋太多了會讓人眼花繚亂。註釋的花樣要少。
¯ 如果代碼本來就是清楚的,則不必加註釋。否則多此一舉,令人厭煩。例如
i++; // i 加 1,多餘的註釋
¯ 邊寫代碼邊註釋,修改代碼同時修改相應的註釋,以保證註釋與代碼的一致性。不再有用的註釋要刪除。
¯ 註釋應當準確、易懂,防止註釋有二義性。錯誤的註釋不但無益反而有害。
¯ 儘量避免在註釋中使用縮寫,特別是不常用縮寫。
¯ 註釋的位置應與被描述的代碼相鄰,可以放在代碼的上方或右方,不可放在下方。
¯ 當代碼比較長,特別是有多重嵌套時,應當在一些段落的結束處加註釋,便於閱讀。
8. 類的版式
類可以將數據和函數封裝在一起,其中函數表示了類的行爲(或稱服務)。類提供關鍵字public、protected和private,分別用於聲明哪些數據和函數是公有的、受保護的或者是私有的。這樣可以達到信息隱藏的目的,即讓類僅僅公開必須要讓外界知道的內容,而隱藏其它一切內容。我們不可以濫用類的封裝功能,不要把它當成火鍋,什麼東西都往裏扔。
在定義類的時候,究竟是以定義數據成員開始還是以定義成員函數開始要看編程者的習慣。以下是兩種方式:
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; … } |
(摘自《高質量C++編程指南》)