高質量C++/C編程指南[3]

3 命名規則

著名的命名規則當推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

 

l         規則3-1-1標識當直且可以拼,可望文知意,不必

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

 

l         規則3-1-2標識符的符合“min-length && max-information”

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

 

l         規則3-1-3命名規則儘量與所採用的操作系開發工具的格保持一致。

例如Windows用程序的標識符通常採用大小寫混排的方式,如AddChild。而Unix用程序的標識符通常採用小寫加下劃的方式,如add_child類風格混在一起用。

 

l         規則3-1-4程序中不要出現僅靠大小寫區分的相似的標識符。

例如:

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

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

void FOO(float x);

 

l         規則3-1-5程序中不要出現標識完全相同的局部量和全局量,儘管兩者的作用域不同而不會錯誤,但會使人解。

 

l         規則3-1-6量的名字當使用或者形容+名

例如:

float  value;

float  oldValue;

float  newValue;

 

l         規則3-1-7全局函數的名字當使用動詞或者動詞+名動賓詞組)。的成函數當只使用動詞,被省略掉的名就是象本身。

例如:

DrawBox();                         // 全局函數

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

 

l         規則3-1-8用正確的反義詞組命名具有互斥意量或相反作的函數等。

例如:

int           minValue;

int           maxValue;

 

int           SetValue(…);

int           GetValue(…);

 

²        【建3-1-1儘量避免名字中出數字號,如Value1,Value2等,除非邏輯上的確需要號。了防止程序員偷懶,不肯命名動腦筋而生無意的名字(因用數字號最省事)。

3.2 簡單Windows用程序命名規則

              作者匈牙利命名規則做了合理的化,下述的命名規則簡單易用,比適合於Windows件的開發

 

l         規則3-2-1名和函數名用大寫字母開頭單詞組合而成。

例如:

              class Node;                                                                    //

              class LeafNode;                                               //

              void  Draw(void);                              // 函數名

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

 

l         規則3-2-2量和參數用小寫字母開頭單詞組合而成。

例如:

              BOOL flag;

              int  drawMode;

 

l         規則3-2-3常量全用大寫的字母,用下劃分割單詞

例如:

              const int MAX = 100;

              const int MAX_LENGTH = 100;

 

l         規則3-2-4態變量加前s_(表示static)。

例如:

void Init(…)

{

              static int s_initValue;             // 態變

             

}

 

l         規則3-2-5如果不得已需要全局量,使全局量加前g_(表示global)。

例如:

int g_howManyPeople;          // 全局

int g_howMuchMoney;         // 全局

 

l         規則3-2-6的數據成加前m_(表示member),這樣可以避免數據成與成函數的參數同名。

例如:

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

              {

                            m_width = width;

m_height = height;

}

 

l         規則3-2-7了防止某一中的一些標識符和其它中的衝突,可以種標識符加上能反映件性的前。例如三維圖OpenGL的所有函數均以gl開頭,所有常量(或宏定)均以GL開頭

3.3 簡單Unix用程序命名規則

 
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章