內(nèi)功深厚的武林高手出招往往平淡無(wú)奇。同理，編程高手也不會(huì)用奇門(mén)怪招寫(xiě)程序。良好的編程風(fēng)格是產(chǎn)生高質(zhì)量程序的前提。 下面以C++為例，來(lái)給大家介紹。

一、 命名約定

有不少人編程時(shí)用拼音給函數(shù)或變量命名，這樣做并不能說(shuō)明你很愛(ài)國(guó)，卻會(huì)讓用此程序的人迷糊（很多南方人不懂拼音，我就不懂）。程序中的英文一般不會(huì)太復(fù)雜，用詞要力求準(zhǔn)確。匈牙利命名法是Microsoft 公司倡導(dǎo)的[Maguire 1993]，雖然很煩瑣，但用習(xí)慣了也就成了自然。沒(méi)有人強(qiáng)迫你采用何種命名法，但有一點(diǎn)應(yīng)該做到：自己的程序命名必須一致。

以下是我編程時(shí)采用的命名約定：

（1）宏定義用大寫(xiě)字母加下劃線(xiàn)表示，如MAX_LENGTH；

（2）函數(shù)用大寫(xiě)字母開(kāi)頭的單詞組合而成，如SetName, GetName ；

（3）指針變量加前綴p，如*pNode ；

（4）BOOL 變量加前綴b，如bFlag ；

（5）int 變量加前綴i，如iWidth ； 

（6）float 變量加前綴f，如fWidth ；

（7）double 變量加前綴d，如dWidth ；

（8）字符串變量加前綴str，如strName ；

（9）枚舉變量加前綴e，如eDrawMode ；

（10）類(lèi)的成員變量加前綴m_，如m_strName, m_iWidth ；

對(duì)于int, float, double 型的變量，如果變量名的含義十分明顯，則不加前綴，避免煩瑣。如用于循環(huán)的int 型變量i,j,k ；float 型的三維坐標(biāo)（x,y,z）等。

二、 使用斷言

程序一般分為Debug 版本和Release 版本，Debug 版本用于內(nèi)部調(diào)試，Release 版本發(fā)行給用戶(hù)使用。斷言assert 是僅在Debug 版本起作用的宏，它用于檢查“不應(yīng)該”發(fā)生的情況。以下是一個(gè)內(nèi)存復(fù)制程序，在運(yùn)行過(guò)程中，如果assert 的參數(shù)為假，那么程序就會(huì)中止（一般地還會(huì)出現(xiàn)提示對(duì)話(huà)，說(shuō)明在什么地方引發(fā)了assert）。

//復(fù)制不重疊的內(nèi)存塊  
void memcpy(void *pvTo, void *pvFrom, size_t size)  
{  
void *pbTo = (byte *) pvTo;  
void *pbFrom = (byte *) pvFrom;  
assert( pvTo != NULL && pvFrom != NULL );  
while(size - - > 0 )  
*pbTo + + = *pbFrom + + ;  
return (pvTo);  
} 

assert 不是一個(gè)倉(cāng)促拼湊起來(lái)的宏，為了不在程序的Debug 版本和Release 版本引起差別，assert 不應(yīng)該產(chǎn)生任何副作用。所以assert 不是函數(shù)，而是宏。程序員可以把a(bǔ)ssert 看成一個(gè)在任何系統(tǒng)狀態(tài)下都可以安全使用的無(wú)害測(cè)試手段。

很少有比跟蹤到程序的斷言，卻不知道該斷言的作用更讓人沮喪的事了。你化了很多時(shí)間，不是為了排除錯(cuò)誤，而只是為了弄清楚這個(gè)錯(cuò)誤到底是什么。有的時(shí)候，程序員偶爾還會(huì)設(shè)計(jì)出有錯(cuò)誤的斷言。所以如果搞不清楚斷言檢查的是什么，就很難判斷錯(cuò)誤是出現(xiàn)在程序中，還是出現(xiàn)在斷言中。幸運(yùn)的是這個(gè)問(wèn)題很好解決，只要加上清晰的注釋即可。這本是顯而易見(jiàn)的事情，可是很少有程序員這樣做。這好比一個(gè)人在森林里，看到樹(shù)上釘著一塊“危險(xiǎn)”的大牌子。但危險(xiǎn)到底是什么？樹(shù)要倒？有廢井？有野獸？除非告訴人們“危險(xiǎn)”是什么，否則這個(gè)警告牌難以起到積極有效的作用。難以理解的斷言常常被程序員忽略，甚至被刪除。[Maguire 1993]

以下是使用斷言的幾個(gè)原則：

（1）使用斷言捕捉不應(yīng)該發(fā)生的非法情況。不要混淆非法情況與錯(cuò)誤情況之間的區(qū)別，后者是必然存在的并且是一定要作出處理的。

（2）使用斷言對(duì)函數(shù)的參數(shù)進(jìn)行確認(rèn)。

（3）在編寫(xiě)函數(shù)時(shí)，要進(jìn)行反復(fù)的考查，并且自問(wèn)：“我打算做哪些假定？”一旦確定了的假定，就要使用斷言對(duì)假定進(jìn)行檢查。

（4）一般教科書(shū)都鼓勵(lì)程序員們進(jìn)行防錯(cuò)性的程序設(shè)計(jì)，但要記住這種編程風(fēng)格會(huì)隱瞞錯(cuò)誤。當(dāng)進(jìn)行防錯(cuò)性編程時(shí)，如果“不可能發(fā)生”的事情的確發(fā)生了，則要使用斷言進(jìn)行報(bào)警。

三、 new、delete 與指針

在C++中，操作符new 用于申請(qǐng)內(nèi)存，操作符delete 用于釋放內(nèi)存。在C 語(yǔ)言中，函數(shù)malloc 用于申請(qǐng)內(nèi)存，函數(shù)free 用于釋放內(nèi) 存。由于C++兼容C 語(yǔ)言，所以new、delete、malloc、free 都有可能一起使用。new 能比malloc 干更多的事，它可以申請(qǐng)對(duì)象的內(nèi)存，而malloc 不能。C++和C 語(yǔ)言中的指針威猛無(wú)比，用錯(cuò)了會(huì)帶來(lái)災(zāi)難。對(duì)于一個(gè)指針p，如果是用new申請(qǐng)的內(nèi)存，則必須用delete 而不能用free 來(lái)釋放。如果是用malloc 申請(qǐng)的內(nèi)存，則必須用free 而不能用delete 來(lái)釋放。在用delete 或用free 釋放p 所指的內(nèi)存后，應(yīng)該馬上顯式地將p 置為NULL，以防下次使用p 時(shí)發(fā)生錯(cuò)誤。示例程序如下：

void Test(void)  
{  
float *p;  
p = new float[100];  
if(p==NULL) return;  
…// do something  
delete p;  
p=NULL; // 良好的編程風(fēng)格  
// 可以繼續(xù)使用p  
p = new float[500];  
if(p==NULL) return;  
…// do something else  
delete p;  
p=NULL;  
} 

我們還要預(yù)防“野指針”，“野指針”是指向“垃圾”內(nèi)存的指針，主要成因有兩種：

（1）指針沒(méi)有初始化。

（2）指針指向已經(jīng)釋放的內(nèi)存，這種情況最讓人防不勝防，示例程序如下：

class A  
{  
public:  
void Func(void){…}  
};  
void Test(void)  
{  
A *p;  
{  
A a;  
p = &a; // 注意a 的生命期  
}  
p->Func(); // p 是“野指針”，程序出錯(cuò)  
} 

四、使用const

在定義一個(gè)常量時(shí)，const 比#define 更加靈活。用const 定義的常量含有數(shù)據(jù)類(lèi)型，該常量可以參與邏輯運(yùn)算。例如：

const int LENGTH = 100; // LENGTH 是int 類(lèi)型  
const float MAX=100; // MAX 是float 類(lèi)型  
#define LENGTH 100 // LENGTH 無(wú)類(lèi)型  
#define MAX 100 // MAX 無(wú)類(lèi)型 

除了能定義常量外，const 還有兩個(gè)“保護(hù)”功能：

一、強(qiáng)制保護(hù)函數(shù)的參數(shù)值不發(fā)生變化

以下程序中，函數(shù)f 不會(huì)改變輸入?yún)?shù)name 的值，但是函數(shù)g 和h 都有可能改變name的值。

void f(String s); // pass by value  
void g(String &s); // pass by referance  
void h(String *s); // pass by pointer  
main()  
{  
String name=“Dog”;  
f(name); // name 的值不會(huì)改變  
g(name); // name 的值可能改變  
h(name); // name 的值可能改變  
} 

對(duì)于一個(gè)函數(shù)而言，如果其‘&’或‘*’類(lèi)型的參數(shù)只作輸入用，不作輸出用，那么應(yīng)當(dāng)在該參數(shù)前加上const，以確保函數(shù)的代碼不會(huì)改變?cè)搮?shù)的值（如果改變了該參數(shù)的值，編譯器會(huì)出現(xiàn)錯(cuò)誤警告）。因此上述程序中的函數(shù)g 和h 應(yīng)該定義成：

void g(const String &s);  
void h(const String *s); 

二、強(qiáng)制保護(hù)類(lèi)的成員函數(shù)不改變?nèi)魏螖?shù)據(jù)成員的值

以下程序中，類(lèi)stack 的成員函數(shù)Count 僅用于計(jì)數(shù)，為了確保Count 不改變類(lèi)中的任何數(shù)據(jù)成員的值，應(yīng)將函數(shù)Count 定義成const 類(lèi)型。

class Stack  
{  
public:  
void push(int elem);  
void pop(void);  
int Count(void) const; // const 類(lèi)型的函數(shù)  
private:  
int num;  
int data[100];  
};  
int Stack::Count(void) const 
{  
++ num; // 編譯錯(cuò)誤，num 值發(fā)生變化  
pop(); // 編譯錯(cuò)誤，pop 將改變成員變量的值  
return num;  
} 

五、 其它建議

（1）不要編寫(xiě)一條過(guò)分復(fù)雜的語(yǔ)句，緊湊的C++/C 代碼并不見(jiàn)到能得到高效率的機(jī)器代碼，卻會(huì)降低程序的可理解性，程序出錯(cuò)誤的幾率也會(huì)提高。

（2）不要編寫(xiě)集多種功能于一身的函數(shù)，在函數(shù)的返回值中，不要將正常值和錯(cuò)誤標(biāo)志混在一起。

（3）不要將BOOL 值TRUE 和FALSE 對(duì)應(yīng)于1 和0 進(jìn)行編程。大多數(shù)編程語(yǔ)言將FALSE定義為0，任何非0 值都是TRUE。Visual C++將TRUE 定義為1，而Visual Basic 則將TRUE定義為-1。示例程序如下：

BOOL flag;  
…  
if(flag) { // do something } // 正確的用法  
if(flag==TRUE) { // do something } // 危險(xiǎn)的用法  
if(flag==1) { // do something } // 危險(xiǎn)的用法  
if(!flag) { // do something } // 正確的用法  
if(flag==FALSE) { // do something } // 不合理的用法  
if(flag==0) { // do something } // 不合理的用法 

（4）小心不要將“= =”寫(xiě)成“=”，編譯器不會(huì)自動(dòng)發(fā)現(xiàn)這種錯(cuò)誤。

（5）不要將123 寫(xiě)成0123，后者是八進(jìn)制的數(shù)值。

（6）將自己經(jīng)常犯的編程錯(cuò)誤記錄下來(lái)，制成表格貼在計(jì)算機(jī)旁邊。

 小結(jié)

C++/C 程序設(shè)計(jì)如同少林寺的武功一樣博大精深，我練了8 年，大概只學(xué)到二三成。所以無(wú)論什么時(shí)候，都不要覺(jué)得自己的編程水平天下第一，看到別人好的技術(shù)和風(fēng)格，要虛心學(xué)習(xí)。本章的內(nèi)容少得可憐，就象口渴時(shí)只給你一顆楊梅吃，你一定不過(guò)癮。我借花獻(xiàn)佛，推薦一本好書(shū)：Marshall P. Cline 著的《C++ FAQs》[Cline 1995]。你看了后一定會(huì)贊不絕口。會(huì)編寫(xiě)C++/C 程序，不要因此得意洋洋，這只是程序員基本的技能要求而已。如果把系統(tǒng)分析和系統(tǒng)設(shè)計(jì)比作“戰(zhàn)略決策”，那么編程充其量只是“戰(zhàn)術(shù)”。

如果指揮官是個(gè)大笨蛋，士兵再勇敢也會(huì)吃敗仗。所以我們程序員不要只把眼光盯在程序上，要讓自己博學(xué)多才。我們應(yīng)該向北京胡同里的小孩們學(xué)習(xí)，他們小小年紀(jì)就能指點(diǎn)江山，評(píng)論世界大事。