高品質C++/C編程指南-第3章-命名規則(1)

第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(); // 類的成員函數