序言:每天更新C++的內容
一、文件結構
每個C++/C程序通常分為兩個文件。一個文件用於保存程序的聲明(declaration),稱為頭文件。另一個文件用於保存程序的實現(implementation),稱為定義(definition)文件。
C++/C程序的頭文件以“.h”為后綴,C程序的定義文件以“.c”為后綴,C++程序的定義文件通常以“.cpp”為后綴(也有一些系統以“.cc”或“.cxx”為后綴)。
1.1 版權和版本的聲明
版權和版本的聲明位於頭文件和定義文件的開頭(參見示例1-1),主要內容有:
(1)版權信息。
(2)文件名稱,標識符,摘要。
(3)當前版本號,作者/修改者,完成日期。
(4)版本歷史信息。
/* * Copyright (c) 時間 公司 * All rights reserved. * * 文件名稱:filename.h * 文件標識:見配置管理計划書 * 摘 要:簡要描述本文件的內容 * * 當前版本:1.1 * 作 者:輸入作者(或修改者)名字 * 完成日期:時間到日 * * 取代版本:1.0 * 原作者 :輸入原作者(或修改者)名字 * 完成日期:時間到日 */
|
示例1-1 版權和版本的聲明
1.2 頭文件的結構
頭文件由三部分內容組成:
(1)頭文件開頭處的版權和版本聲明(參見示例1-1)。
(2)預處理塊。
(3)函數和類結構聲明等。
假設頭文件名稱為 graphics.h,頭文件的結構參見示例1-2。
【規則1-2-1】為了防止頭文件被重復引用,應當用ifndef/define/endif結構產生預處理塊。
【規則1-2-2】用 #include <filename.h> 格式來引用標准庫的頭文件(編譯器將從標准庫目錄開始搜索)。
【規則1-2-3】用 #include “filename.h” 格式來引用非標准庫的頭文件(編譯器將從用戶的工作目錄開始搜索)。
【建議1-2-1】頭文件中只存放“聲明”而不存放“定義”
在C++ 語法中,類的成員函數可以在聲明的同時被定義,並且自動成為內聯函數。這雖然會帶來書寫上的方便,但卻造成了風格不一致,弊大於利。建議將成員函數的定義與聲明分開,不論該函數體有多么小。
【建議1-2-2】不提倡使用全局變量,盡量不要在頭文件中出現象extern int value 這類聲明。
// 版權和版本聲明見示例1-1,此處省略。
#ifndef GRAPHICS_H // 防止graphics.h被重復引用 #define GRAPHICS_H //#ifndef GRAPHICS_H //#define GRAPHICS_H //#include<math.h> //#include”myheader.h” //Void Functionl() //Class Box #include <math.h> // 引用標准庫的頭文件 … #include “myheader.h” // 引用非標准庫的頭文件 … void Function1(…); // 全局函數聲明 … class Box // 類結構聲明 { … }; #endif |
示例1-2 C++/C頭文件的結構
1.3 定義文件的結構
定義文件有三部分內容:
(1) 定義文件開頭處的版權和版本聲明(參見示例1-1)。
(2) 對一些頭文件的引用。
(3) 程序的實現體(包括數據和代碼)。
假設定義文件的名稱為 graphics.cpp,定義文件的結構參見示例1-3。
// 版權和版本聲明見示例1-1,此處省略。
#include “graphics.h” // 引用頭文件 …
// 全局函數的實現體 void Function1(…) { … }
// 類成員函數的實現體 void Box::Draw(…)//void Box::Draw { … } |
示例1-3 C++/C定義文件的結構
1.4 頭文件的作用
早期的編程語言如Basic、Fortran沒有頭文件的概念,C++/C語言的初學者雖然會用使用頭文件,但常常不明其理。這里對頭文件的作用略作解釋:
(1)通過頭文件來調用庫功能。在很多場合,源代碼不便(或不准)向用戶公布,只要向用戶提供頭文件和二進制的庫即可。用戶只需要按照頭文件中的接口聲明來調用庫功能,而不必關心接口怎么實現的。編譯器會從庫中提取相應的代碼。
(2)頭文件能加強類型安全檢查。如果某個接口被實現或被使用時,其方式與頭文件中的聲明不一致,編譯器就會指出錯誤,這一簡單的規則能大大減輕程序員調試、改錯的負擔。
1.5 目錄結構
如果一個軟件的頭文件數目比較多(如超過十個),通常應將頭文件和定義文件分別保存於不同的目錄,以便於維護。
例如可將頭文件保存於include目錄,將定義文件保存於source目錄(可以是多級目錄)。
如果某些頭文件是私有的,它不會被用戶的程序直接引用,則沒有必要公開其“聲明”。為了加強信息隱藏,這些私有的頭文件可以和定義文件存放於同一個目錄。
二、 程序的版式
版式雖然不會影響程序的功能,但會影響可讀性。程序的版式追求清晰、美觀,是程序風格的重要構成因素。
可以把程序的版式比喻為“書法”。好的“書法”可讓人對程序一目了然,看得興致勃勃。差的程序“書法”如螃蟹爬行,讓人看得索然無味,更令維護者煩惱有加。請程序員們學習程序的“書法”,彌補大學計算機教育的漏洞,實在很有必要。
2.1 空行
空行起着分隔程序段落的作用。空行得體(不過多也不過少)將使程序的布局更加清晰。空行不會浪費內存,雖然打印含有空行的程序是會多消耗一些紙張,但是值得。所以不要舍不得用空行。
【規則2-1-1】在每個類聲明之后、每個函數定義結束之后都要加空行。參見示例2-1(a)
【規則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 代碼行
【規則2-2-1】一行代碼只做一件事情,如只定義一個變量,或只寫一條語句。這樣的代碼容易閱讀,並且方便於寫注釋。
【規則2-2-2】if、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 代碼行內的空格
【規則2-3-1】關鍵字之后要留空格。象const、virtual、inline、case 等關鍵字之后至少要留一個空格,否則無法辨析關鍵字。象if、for、while等關鍵字之后應留一個空格再跟左括號‘(’,以突出關鍵字。
【規則2-3-2】函數名之后不要留空格,緊跟左括號‘(’,以與關鍵字區別。
【規則2-3-3】‘(’向后緊跟,‘)’、‘,’、‘;’向前緊跟,緊跟處不留空格。
【規則2-3-4】‘,’之后要留空格,如Function(x, y, z)。如果‘;’不是一行的結束符號,其后要留空格,如for (initialization; condition; update)。
【規則2-3-5】賦值操作符、比較操作符、算術操作符、邏輯操作符、位域操作符,如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后應當加空格。
【規則2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”(地址運算符)等前后不加空格。
【規則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 對齊
【規則2-4-1】程序的分界符‘{’和‘}’應獨占一行並且位於同一列,同時與引用它們的語句左對齊。
【規則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 長行拆分
【規則2-5-1】代碼行最大長度宜控制在70至80個字符以內。代碼行不要過長,否則眼睛看不過來,也不便於打印。
【規則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分行定義可以避免誤解,但並不是人人都願意這樣做。
【規則2-6-1】應當將修飾符 * 和 & 緊靠變量名
例如:
char *name;
int *x, y; // 此處y不會被誤解為指針
2.7 注釋
C語言的注釋符為“/*…*/”。C++語言中,程序塊的注釋常采用“/*…*/”,行注釋一般采用“//…”。注釋通常用於:
(1)版本、版權聲明;
(2)函數接口說明;
(3)重要的代碼行或段落提示。
雖然注釋有助於理解代碼,但注意不可過多地使用注釋。參見示例2-6。
【規則2-7-1】注釋是對代碼的“提示”,而不是文檔。程序中的注釋不可喧賓奪主,注釋太多了會讓人眼花繚亂。注釋的花樣要少。
【規則2-7-2】如果代碼本來就是清楚的,則不必加注釋。否則多此一舉,令人厭煩。例如
i++; // i 加 1,多余的注釋
【規則2-7-3】邊寫代碼邊注釋,修改代碼同時修改相應的注釋,以保證注釋與代碼的一致性。不再有用的注釋要刪除。
【規則2-7-4】注釋應當准確、易懂,防止注釋有二義性。錯誤的注釋不但無益反而有害。
【規則2-7-5】盡量避免在注釋中使用縮寫,特別是不常用縮寫。
【規則2-7-6】注釋的位置應與被描述的代碼相鄰,可以放在代碼的上方或右方,不可放在下方。
【規則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) 以行為為中心的版式
三、總結
學習C++編程需要有耐心也是需要注意細節,多規范自己的寫法,對自己的習慣有莫大的好處,要勤加練習。
改變自己,從現在做起-----------久館