C++新手之培養(yǎng)良好的編程風格
內(nèi)功深厚的武林高手出招往往平淡無奇。同理,編程高手也不會用奇門怪招寫程序。良好的編程風格是產(chǎn)生高質(zhì)量程序的前提。 下面以C++為例,來給大家介紹。
一、 命名約定
有不少人編程時用拼音給函數(shù)或變量命名,這樣做并不能說明你很愛國,卻會讓用此程序的人迷糊(很多南方人不懂拼音,我就不懂)。程序中的英文一般不會太復雜,用詞要力求準確。匈牙利命名法是Microsoft 公司倡導的[Maguire 1993],雖然很煩瑣,但用習慣了也就成了自然。沒有人強迫你采用何種命名法,但有一點應該做到:自己的程序命名必須一致。
以下是我編程時采用的命名約定:
(1)宏定義用大寫字母加下劃線表示,如MAX_LENGTH;
(2)函數(shù)用大寫字母開頭的單詞組合而成,如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)類的成員變量加前綴m_,如m_strName, m_iWidth ;
對于int, float, double 型的變量,如果變量名的含義十分明顯,則不加前綴,避免煩瑣。如用于循環(huán)的int 型變量i,j,k ;float 型的三維坐標(x,y,z)等。
二、 使用斷言
程序一般分為Debug 版本和Release 版本,Debug 版本用于內(nèi)部調(diào)試,Release 版本發(fā)行給用戶使用。斷言assert 是僅在Debug 版本起作用的宏,它用于檢查“不應該”發(fā)生的情況。以下是一個內(nèi)存復制程序,在運行過程中,如果assert 的參數(shù)為假,那么程序就會中止(一般地還會出現(xiàn)提示對話,說明在什么地方引發(fā)了assert)。
- //復制不重疊的內(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 不是一個倉促拼湊起來的宏,為了不在程序的Debug 版本和Release 版本引起差別,assert 不應該產(chǎn)生任何副作用。所以assert 不是函數(shù),而是宏。程序員可以把assert 看成一個在任何系統(tǒng)狀態(tài)下都可以安全使用的無害測試手段。
很少有比跟蹤到程序的斷言,卻不知道該斷言的作用更讓人沮喪的事了。你化了很多時間,不是為了排除錯誤,而只是為了弄清楚這個錯誤到底是什么。有的時候,程序員偶爾還會設(shè)計出有錯誤的斷言。所以如果搞不清楚斷言檢查的是什么,就很難判斷錯誤是出現(xiàn)在程序中,還是出現(xiàn)在斷言中。幸運的是這個問題很好解決,只要加上清晰的注釋即可。這本是顯而易見的事情,可是很少有程序員這樣做。這好比一個人在森林里,看到樹上釘著一塊“危險”的大牌子。但危險到底是什么?樹要倒?有廢井?有野獸?除非告訴人們“危險”是什么,否則這個警告牌難以起到積極有效的作用。難以理解的斷言常常被程序員忽略,甚至被刪除。[Maguire 1993]
以下是使用斷言的幾個原則:
(1)使用斷言捕捉不應該發(fā)生的非法情況。不要混淆非法情況與錯誤情況之間的區(qū)別,后者是必然存在的并且是一定要作出處理的。
(2)使用斷言對函數(shù)的參數(shù)進行確認。
(3)在編寫函數(shù)時,要進行反復的考查,并且自問:“我打算做哪些假定?”一旦確定了的假定,就要使用斷言對假定進行檢查。
(4)一般教科書都鼓勵程序員們進行防錯性的程序設(shè)計,但要記住這種編程風格會隱瞞錯誤。當進行防錯性編程時,如果“不可能發(fā)生”的事情的確發(fā)生了,則要使用斷言進行報警。
三、 new、delete 與指針
在C++中,操作符new 用于申請內(nèi)存,操作符delete 用于釋放內(nèi)存。在C 語言中,函數(shù)malloc 用于申請內(nèi)存,函數(shù)free 用于釋放內(nèi) 存。由于C++兼容C 語言,所以new、delete、malloc、free 都有可能一起使用。new 能比malloc 干更多的事,它可以申請對象的內(nèi)存,而malloc 不能。C++和C 語言中的指針威猛無比,用錯了會帶來災難。對于一個指針p,如果是用new申請的內(nèi)存,則必須用delete 而不能用free 來釋放。如果是用malloc 申請的內(nèi)存,則必須用free 而不能用delete 來釋放。在用delete 或用free 釋放p 所指的內(nèi)存后,應該馬上顯式地將p 置為NULL,以防下次使用p 時發(fā)生錯誤。示例程序如下:
- void Test(void)
- {
- float *p;
- p = new float[100];
- if(p==NULL) return;
- …// do something
- delete p;
- p=NULL; // 良好的編程風格
- // 可以繼續(xù)使用p
- p = new float[500];
- if(p==NULL) return;
- …// do something else
- delete p;
- p=NULL;
- }
我們還要預防“野指針”,“野指針”是指向“垃圾”內(nèi)存的指針,主要成因有兩種:
(1)指針沒有初始化。
(2)指針指向已經(jīng)釋放的內(nèi)存,這種情況最讓人防不勝防,示例程序如下:
- class A
- {
- public:
- void Func(void){…}
- };
- void Test(void)
- {
- A *p;
- {
- A a;
- p = &a; // 注意a 的生命期
- }
- p->Func(); // p 是“野指針”,程序出錯
- }
四、使用const
在定義一個常量時,const 比#define 更加靈活。用const 定義的常量含有數(shù)據(jù)類型,該常量可以參與邏輯運算。例如:
- const int LENGTH = 100; // LENGTH 是int 類型
- const float MAX=100; // MAX 是float 類型
- #define LENGTH 100 // LENGTH 無類型
- #define MAX 100 // MAX 無類型
除了能定義常量外,const 還有兩個“保護”功能:
一、強制保護函數(shù)的參數(shù)值不發(fā)生變化
以下程序中,函數(shù)f 不會改變輸入?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 的值不會改變
- g(name); // name 的值可能改變
- h(name); // name 的值可能改變
- }
對于一個函數(shù)而言,如果其‘&’或‘*’類型的參數(shù)只作輸入用,不作輸出用,那么應當在該參數(shù)前加上const,以確保函數(shù)的代碼不會改變該參數(shù)的值(如果改變了該參數(shù)的值,編譯器會出現(xiàn)錯誤警告)。因此上述程序中的函數(shù)g 和h 應該定義成:
- void g(const String &s);
- void h(const String *s);
二、強制保護類的成員函數(shù)不改變?nèi)魏螖?shù)據(jù)成員的值
以下程序中,類stack 的成員函數(shù)Count 僅用于計數(shù),為了確保Count 不改變類中的任何數(shù)據(jù)成員的值,應將函數(shù)Count 定義成const 類型。
- class Stack
- {
- public:
- void push(int elem);
- void pop(void);
- int Count(void) const; // const 類型的函數(shù)
- private:
- int num;
- int data[100];
- };
- int Stack::Count(void) const
- {
- ++ num; // 編譯錯誤,num 值發(fā)生變化
- pop(); // 編譯錯誤,pop 將改變成員變量的值
- return num;
- }
五、 其它建議
(1)不要編寫一條過分復雜的語句,緊湊的C++/C 代碼并不見到能得到高效率的機器代碼,卻會降低程序的可理解性,程序出錯誤的幾率也會提高。
(2)不要編寫集多種功能于一身的函數(shù),在函數(shù)的返回值中,不要將正常值和錯誤標志混在一起。
(3)不要將BOOL 值TRUE 和FALSE 對應于1 和0 進行編程。大多數(shù)編程語言將FALSE定義為0,任何非0 值都是TRUE。Visual C++將TRUE 定義為1,而Visual Basic 則將TRUE定義為-1。示例程序如下:
- BOOL flag;
- …
- if(flag) { // do something } // 正確的用法
- if(flag==TRUE) { // do something } // 危險的用法
- if(flag==1) { // do something } // 危險的用法
- if(!flag) { // do something } // 正確的用法
- if(flag==FALSE) { // do something } // 不合理的用法
- if(flag==0) { // do something } // 不合理的用法
(4)小心不要將“= =”寫成“=”,編譯器不會自動發(fā)現(xiàn)這種錯誤。
(5)不要將123 寫成0123,后者是八進制的數(shù)值。
(6)將自己經(jīng)常犯的編程錯誤記錄下來,制成表格貼在計算機旁邊。
小結(jié)
C++/C 程序設(shè)計如同少林寺的武功一樣博大精深,我練了8 年,大概只學到二三成。所以無論什么時候,都不要覺得自己的編程水平天下第一,看到別人好的技術(shù)和風格,要虛心學習。本章的內(nèi)容少得可憐,就象口渴時只給你一顆楊梅吃,你一定不過癮。我借花獻佛,推薦一本好書:Marshall P. Cline 著的《C++ FAQs》[Cline 1995]。你看了后一定會贊不絕口。會編寫C++/C 程序,不要因此得意洋洋,這只是程序員基本的技能要求而已。如果把系統(tǒng)分析和系統(tǒng)設(shè)計比作“戰(zhàn)略決策”,那么編程充其量只是“戰(zhàn)術(shù)”。
如果指揮官是個大笨蛋,士兵再勇敢也會吃敗仗。所以我們程序員不要只把眼光盯在程序上,要讓自己博學多才。我們應該向北京胡同里的小孩們學習,他們小小年紀就能指點江山,評論世界大事。