高質量C++/C編程指南--第3章命名規(guī)則

字號:

第3章 命名規(guī)則
    比較的命名規(guī)則當推Microsoft公司的“匈牙利”法,該命名規(guī)則的主要思想是“在變量和函數名中加入前綴以增進人們對程序的理解”。例如所有的字符變量均以ch為前綴,若是指針變量則追加前綴p。如果一個變量由ppch開頭,則表明它是指向字符指針的指針。
    “匈牙利”法的缺點是煩瑣,例如
    int i, j, k;
    float x, y, z;
    倘若采用“匈牙利”命名規(guī)則,則應當寫成
    int iI, iJ, ik; // 前綴 i表示int類型
    float fX, fY, fZ; // 前綴 f表示float類型
    如此煩瑣的程序會讓絕大多數程序員無法忍受。
    據考察,沒有一種命名規(guī)則可以讓所有的程序員贊同,程序設計教科書一般都不指定命名規(guī)則。命名規(guī)則對軟件產品而言并不是“成敗悠關”的事,我們不要化太多精力試圖發(fā)明世界上的命名規(guī)則,而應當制定一種令大多數項目成員滿意的命名規(guī)則,并在項目中貫徹實施。
    3.1 共性規(guī)則
    本節(jié)論述的共性規(guī)則是被大多數程序員采納的,我們應當在遵循這些共性規(guī)則的前提下,再擴充特定的規(guī)則,如3.2節(jié)。
    l 【規(guī)則3-1-1】標識符應當直觀且可以拼讀,可望文知意,不必進行“解碼”。
    標識符采用英文單詞或其組合,便于記憶和閱讀。切忌使用漢語拼音來命名。程序中的英文單詞一般不會太復雜,用詞應當準確。例如不要把CurrentValue寫成NowValue。
    l 【規(guī)則3-1-2】標識符的長度應當符合“min-length && max-information”原則。
    幾十年前老ANSI C規(guī)定名字不準超過6個字符,現今的C++/C不再有此限制。一般來說,長名字能更好地表達含義,所以函數名、變量名、類名長達十幾個字符不足為怪。那么名字是否越長約好?不見得! 例如變量名maxval就比maxValueUntilOverflow好用。單字符的名字也是有用的,常見的如i,j,k,m,n,x,y,z等,它們通??捎米骱瘮祪鹊木植孔兞?。
    l 【規(guī)則3-1-3】命名規(guī)則盡量與所采用的操作系統(tǒng)或開發(fā)工具的風格保持一致。
    例如Windows應用程序的標識符通常采用“大小寫”混排的方式,如AddChild。而Unix應用程序的標識符通常采用“小寫加下劃線”的方式,如add_child。別把這兩類風格混在一起用。
    l 【規(guī)則3-1-4】程序中不要出現僅靠大小寫區(qū)分的相似的標識符。
    例如:
    int x, X; // 變量x 與 X 容易混淆
    void foo(int x); // 函數foo 與FOO容易混淆
    void FOO(float x);
    l 【規(guī)則3-1-5】程序中不要出現標識符完全相同的局部變量和全局變量,盡管兩者的作用域不同而不會發(fā)生語法錯誤,但會使人誤解。
    l 【規(guī)則3-1-6】變量的名字應當使用“名詞”或者“形容詞+名詞”。
    例如:
    float value;
    float oldValue;
    float newValue;
    l 【規(guī)則3-1-7】全局函數的名字應當使用“動詞”或者“動詞+名詞”(動賓詞組)。類的成員函數應當只使用“動詞”,被省略掉的名詞就是對象本身。
    例如:
    DrawBox(); // 全局函數
    box->Draw(); // 類的成員函數
    l 【規(guī)則3-1-8】用正確的反義詞組命名具有互斥意義的變量或相反動作的函數等。
    例如:
    int minValue;
    int maxValue;
    int SetValue(…);
    int GetValue(…);
    2 【建議3-1-1】盡量避免名字中出現數字編號,如Value1,Value2等,除非邏輯上的確需要編號。這是為了防止程序員偷懶,不肯為命名動腦筋而導致產生無意義的名字(因為用數字編號最省事)。
    3.2 簡單的Windows應用程序命名規(guī)則
    作者對“匈牙利”命名規(guī)則做了合理的簡化,下述的命名規(guī)則簡單易用,比較適合于Windows應用軟件的開發(fā)。
    l 【規(guī)則3-2-1】類名和函數名用大寫字母開頭的單詞組合而成。
    例如:
    class Node; // 類名
    class LeafNode; // 類名
    void Draw(void); // 函數名
    void SetValue(int value); // 函數名
    l 【規(guī)則3-2-2】變量和參數用小寫字母開頭的單詞組合而成。
    例如:
    BOOL flag;
    int drawMode;
    l 【規(guī)則3-2-3】常量全用大寫的字母,用下劃線分割單詞。
    例如:
    const int MAX = 100;
    const int MAX_LENGTH = 100;
    l 【規(guī)則3-2-4】靜態(tài)變量加前綴s_(表示static)。
    例如:
    void Init(…)
    {
    static int s_initValue; // 靜態(tài)變量
    …
    }
    l 【規(guī)則3-2-5】如果不得已需要全局變量,則使全局變量加前綴g_(表示global)。
    例如:
    int g_howManyPeople; // 全局變量
    int g_howMuchMoney; // 全局變量
    l 【規(guī)則3-2-6】類的數據成員加前綴m_(表示member),這樣可以避免數據成員與成員函數的參數同名。
    例如:
    void Object::SetValue(int width, int height)