C++編程指南續

三、 命名規則

比較著名的命名規則當推Microsoft公司的「匈牙利」法,該命名規則的主要思想是「在變數和函數名中加入前綴以增進人們對程式的理解」。例如所有的字元變數均以ch為前綴,若是指針變數則追加前綴p。如果一個變數由ppch開頭,則表明它是指向字元指針的指針。

「匈牙利」法最大的缺點是煩瑣,例如

int    i,  j,  k;  

float  x,  y,  z;

倘若採用「匈牙利」命名規則,則應當寫成

int    iI,  iJ,  ik;  // 前綴 i表示int類型

float  fX,  fY,  fZ;  // 前綴 f表示float類型

如此煩瑣的程式會讓絕大多數程式設計師無法忍受。

據考察,沒有一種命名規則可以讓所有的程式設計師贊同,程式設計教科書一般都不指定命名規則。命名規則對軟體產品而言並不是「成敗悠關」的事,我們不要化太多精力試圖發明世界上最好的命名規則,而應當制定一種令大多數項目成員滿意的命名規則,並在項目中貫徹實施。

3.1 共性規則

本節論述的共性規則是被大多數程式設計師採納的,我們應當在遵循這些共性規則的前提下,再擴充特定的規則,如3.2節。

【規則31-1標識符應當直觀且可以拼讀,可望文知意,不必進行「解碼」。

標識符最好採用英文單詞或其組合,便於記憶和閱讀。切忌使用漢語拼音來命名。程式中的英文單詞一般不會太複雜,用詞應當準確。例如不要把CurrentValue寫成NowValue。

【規則31-2標識符的長度應當符合「min-length && max-information」原則。

幾十年前老ANSI C規定名字不準超過6個字元,現今的C++/C不再有此限制。一般來說,長名字能更好地表達含義,所以函數名、變數名、類名長達十幾個字元不足為怪。那麼名字是否越長約好?不見得! 例如變數名maxval就比maxValueUntilOverflow好用。單字元的名字也是有用的,常見的如i,j,k,m,n,x,y,z等,它們通常可用作函數內的局部變數。

【規則31-3命名規則盡量與所採用的作業系統或開發工具的風格保持一致。

例如Windows應用程式的標識符通常採用「大小寫」混排的方式,如AddChild。而Unix應用程式的標識符通常採用「小寫加下劃線」的方式,如add_child。別把這兩類風格混在一起用。 

【規則31-4程式中不要出現僅靠大小寫區分的相似的標識符。

例如:

int  x,  X; // 變數x X 容易混淆

void foo(int x); // 函數foo 與FOO容易混淆

void FOO(float x); 

【規則31-5程式中不要出現標識符完全相同的局部變數和全局變數,儘管兩者的作用域不同而不會發生語法錯誤,但會使人誤解。 

【規則31-6變數的名字應當使用「名詞」或者「形容詞+名詞」。

例如:

float  value;

float  oldValue;

float  newValue;

【規則31-7全局函數的名字應當使用「動詞」或者「動詞+名詞」(動賓片語)。類的成員函數應當只使用「動詞」,被省略掉的名詞就是對象本身。

例如:

DrawBox(); // 全局函數

box->Draw(); // 類的成員函數

【規則31-8用正確的反義片語命名具有互斥意義的變數或相反動作的函數等。

例如:

int minValue;

int maxValue;

int SetValue(…);

int GetValue(…);

【建議31-1盡量避免名字中出現數字編號,如Value1,Value2等,除非邏輯上的確需要編號。這是為了防止程式設計師偷懶,不肯為命名動腦筋而導致產生無意義的名字(因為用數字編號最省事)。

3.2 簡單的Windows應用程式命名規則

作者對「匈牙利」命名規則做了合理的簡化,下述的命名規則簡單易用,比較適合於Windows應用軟體的開發。 

【規則32-1類名和函數名用大寫字母開頭的單片語合而成。

例如:

class Node; // 類名

class LeafNode; // 類名

void  Draw(void); // 函數名

void  SetValue(int value); // 函數名 

【規則322變數和參數用小寫字母開頭的單片語合而成。

例如:

BOOL flag;

int  drawMode; 

【規則323常量全用大寫的字母,用下劃線分割單詞。

例如:

const int MAX = 100;

const int MAX_LENGTH = 100; 

【規則324靜態變數加前綴s_(表示static)。

例如:

void Init(…)

{

static int s_initValue; // 靜態變數

【規則325如果不得已需要全局變數,則使全局變數加前綴g_(表示global)。

例如:

int g_howManyPeople; // 全局變數

int g_howMuchMoney; // 全局變數 

【規則326類的數據成員加前綴m_(表示member),這樣可以避免數據成員與成員函數的參數同名。

例如:

void Object::SetValue(int width, int height)

{

m_width = width;

m_height = height;

【規則327為了防止某一軟體庫中的一些標識符和其它軟體庫中的衝突,可以為各種標識符加上能反映軟體性質的前綴。例如三維圖形標準OpenGL的所有庫函數均以gl開頭,所有常量(或宏定義)均以GL開頭。

四、表達式和基本語句

讀者可能懷疑:連if、for、while、goto、switch這樣簡單的東西也要探討編程風格,是不是小題大做?

我真的發覺很多程式設計師用隱含錯誤的方式寫表達式和基本語句,我自己也犯過類似的錯誤。

表達式和語句都屬於C++/C的短語結構語法。它們看似簡單,但使用時隱患比較多。本章歸納了正確使用表達式和語句的一些規則與建議。

4.1 運算符的優先順序

C++/C語言的運算符有數十個,運算符的優先順序與結合律如表4-1所示。注意一元運算符 +  –  * 的優先順序高於對應的二元運算符。

 

優先順序

運算符

結合律

 

 

 

 

 

 

 

( )  [ ]  ->  .

從左至右

!  ~  ++  —  (類型) sizeof

+  –  *  &

從右至左

 

*  /  %

從左至右

+  –

從左至右

<<  >>

從左至右

<   <=   >  >=

從左至右

==  !=

從左至右

&

從左至右

^

從左至右

|

從左至右

&&

從左至右

||

從右至左

?:

從右至左

=  +=  -=  *=  /=  %=  &=  ^=

|=  <<=  >>=

從左至右

表4-1 運算符的優先順序與結合律

 

【規則411】如果程式碼行中的運算符比較多,用括弧確定表達式的操作順序,避免使用默認的優先順序。

由於將表4-1熟記是比較困難的,為了防止產生歧義並提高可讀性,應當用括弧確定表達式的操作順序。例如:

word = (high << 8) | low

if ((a | b) && (a & c))

4.2 複合表達式

a = b = c = 0這樣的表達式稱為複合表達式。允許複合表達式存在的理由是:(1)書寫簡潔;(2)可以提高編譯效率。但要防止濫用複合表達式。

【規則4-2-1不要編寫太複雜的複合表達式。

例如:

  i = a >= b && c < d && c + f <= g + h ; // 複合表達式過於複雜

【規則4-2-2不要有多用途的複合表達式。

例如:

d = (a = b + c) + r ;

該表達式既求a值又求d值。應該拆分為兩個獨立的語句:

a = b + c;

d = a + r;

【規則4-2-3不要把程式中的複合表達式與「真正的數學表達式」混淆。

例如:

if (a < b < c) // a < b < c是數學表達式而不是程式表達式

並不表示

if ((a<b) && (b<c))

而是成了令人費解的

if ( (a<b)<c )

4.3 if 語句

if語句是C++/C語言中最簡單、最常用的語句,然而很多程式設計師用隱含錯誤的方式寫if語句。本節以「與零值比較」為例,展開討論。

4.3.1 布爾變數與零值比較

【規則43-1不可將布爾變數直接與TRUE、FALSE或者10進行比較。

根據布爾類型的語義,零值為「假」(記為FALSE),任何非零值都是「真」(記為TRUE)。TRUE的值究竟是什麼並沒有統一的標準。例如Visual C++ TRUE定義為1,而Visual Basic則將TRUE定義為-1

假設布爾變數名字為flag,它與零值比較的標準if語句如下:

if (flag) // 表示flag為真

if (!flag) // 表示flag為假

其它的用法都屬於不良風格,例如:

if (flag == TRUE)

if (flag == 1 )

if (flag == FALSE)  

if (flag == 0)

4.3.2 整型變數與零值比較

【規則432應當將整型變數用「==」或「!=」直接與0比較。

假設整型變數的名字為value,它與零值比較的標準if語句如下:

if (value == 0)  

if (value != 0)

不可模仿布爾變數的風格而寫成

if (value) // 會讓人誤解 value是布爾變數

if (!value) 

4.3.3 浮點變數與零值比較

【規則433不可將浮點變數用「==」或「!=」與任何數字比較。

千萬要留意,無論是float還是double類型的變數,都有精度限制。所以一定要避免將浮點變數用「==」或「!=」與數字比較,應該設法轉化成「>=」或「<=」形式。

假設浮點變數的名字為x,應當將

if (x == 0.0)  // 隱含錯誤的比較

轉化為

if ((x>=-EPSINON) && (x<=EPSINON))

其中EPSINON是允許的誤差(即精度)。

4.3.4 指針變數與零值比較

【規則434應當將指針變數用「==」或「!=」與NULL比較。

指針變數的零值是「空」(記為NULL)。儘管NULL的值與0相同,但是兩者意義不同。假設指針變數的名字為p,它與零值比較的標準if語句如下:

if (p == NULL) // p與NULL顯式比較,強調p是指針變數

if (p != NULL)

不要寫成

if (p == 0) // 容易讓人誤解p是整型變數

if (p != 0)    

或者

if (p) // 容易讓人誤解p是布爾變數

if (!p)

4.3.5 if語句的補充說明

有時候我們可能會看到 if (NULL == p) 這樣古怪的格式。不是程式寫錯了,是程式設計師為了防止將 if (p == NULL) 誤寫成 if (p = NULL),而有意把p和NULL顛倒。編譯器認為 if (p = NULL) 是合法的,但是會指出 if (NULL = p)是錯誤的,因為NULL不能被賦值。

程式中有時會遇到if/else/return的組合,應該將如下不良風格的程式

if (condition)

return x;

return y;

改寫為

if (condition)

{

return x;

}

else

{

return y;

}

或者改寫成更加簡練的

return (condition ? x : y);

4.4 循環語句的效率

C++/C循環語句中,for語句使用頻率最高,while語句其次,do語句很少用。本節重點論述循環體的效率。提高循環體效率的基本辦法是降低循環體的複雜性。

【建議4-4-1在多重循環中,如果有可能,應當將最長的循環放在最內層,最短的循環放在最外層,以減少CPU跨切循環層的次數。例如示例4-4(b)的效率比示例4-4(a)的高。

 

for (row=0; row<100; row++)

{

for ( col=0; col<5; col++ )

{

sum = sum + a[row][col];

}

}

for (col=0; col<5; col++ )

{

for (row=0; row<100; row++)

{

    sum = sum + a[row][col];

}

}

                  示例4-4(a) 低效率:長循環在最外層           示例4-4(b) 高效率:長循環在最內層

【建議4-4-2如果循環體記憶體在邏輯判斷,並且循環次數很大,宜將邏輯判斷移到循環體的外面。示例4-4(c)的程式比示例4-4(d)多執行了N-1次邏輯判斷。並且由於前者老要進行邏輯判斷,打斷了循環「流水線」作業,使得編譯器不能對循環進行優化處理,降低了效率。如果N非常大,最好採用示例4-4(d)的寫法,可以提高效率。如果N非常小,兩者效率差別並不明顯,採用示例4-4(c)的寫法比較好,因為程式更加簡潔。

for (i=0; i<N; i++)

{

if (condition)

    DoSomething();

else

    DoOtherthing();

}

if (condition)

{

for (i=0; i<N; i++)

    DoSomething();

}

else

{

    for (i=0; i<N; i++)

    DoOtherthing();

}

                        表4-4(c) 效率低但程式簡潔                4-4(d) 效率高但程式不簡潔

4.5 for 語句的循環控制變數

【規則451不可在for 循環體內修改循環變數,防止for 循環失去控制。

【建議451建議for語句的循環控制變數的取值採用「半開半閉區間」寫法。

示例4-5(a)中的x值屬於半開半閉區間「0 =< x < N」,起點到終點的間隔為N,循環次數為N。

示例4-5(b)中的x值屬於閉區間「0 =< x <= N-1」,起點到終點的間隔為N-1,循環次數為N。

相比之下,示例4-5(a)的寫法更加直觀,儘管兩者的功能是相同的。

for (int x=0; x<N; x++)

{

}

for (int x=0; x<=N-1; x++)

{

}

                    示例4-5(a) 循環變數屬於半開半閉區間           示例4-5(b) 循環變數屬於閉區間

4.6 switch語句

有了if語句為什麼還要switch語句?

switch是多分支選擇語句,而if語句只有兩個分支可供選擇。雖然可以用嵌套的if語句來實現多分支選擇,但那樣的程式冗長難讀。這是switch語句存在的理由。

switch語句的基本格式是:

switch (variable)

{

case value1 : …

break;

case value2 : …

break;

default :   …

break;

}

【規則4-6-1每個case語句的結尾不要忘了加break,否則將導致多個分支重疊(除非有意使多個分支重疊)。

【規則4-6-2不要忘記最後那個default分支。即使程式真的不需要default處理,也應該保留語句 default : break; 這樣做並非多此一舉,而是為了防止別人誤以為你忘了default處理。

4.7 goto語句

自從提倡結構化設計以來,goto就成了有爭議的語句。首先,由於goto語句可以靈活跳轉,如果不加限制,它的確會破壞結構化設計風格。其次,goto語句經常帶來錯誤或隱患。它可能跳過了某些對象的構造、變數的初始化、重要的計算等語句,例如:

goto state;

String s1, s2; // 被goto跳過

int sum = 0; // 被goto跳過

state:

如果編譯器不能發覺此類錯誤,每用一次goto語句都可能留下隱患。

很多人建議廢除C++/C的goto語句,以絕後患。但實事求是地說,錯誤是程式設計師自己造成的,不是goto的過錯。goto 語句至少有一處可顯神通,它能從多重循環體中咻地一下子跳到外面,用不著寫很多次的break語句; 例如

{ …

{ …

{ …

goto error;

}

}

}

error:

就象樓房著火了,來不及從樓梯一級一級往下走,可從窗口跳出火坑。所以我們主張少用、慎用goto語句,而不是禁用。

總結:學習了基本語句與表達式就可以寫簡單的demo程式了。

                                  改變自己,從現在做起———–久館

Tags: