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