(轉(zhuǎn)載自http://blog.csdn.net/huayehanshan/article/details/3860363)
在軟件開發(fā)過程中,代碼的命名規(guī)范是一項(xiàng)很突出的內(nèi)容。一套定義完整、結(jié)構(gòu)清晰明了的命名規(guī)范將大大提升源代碼的可讀性和軟件的可維護(hù)性。
據(jù)考證,沒有一種命名規(guī)則可以讓所有的程序員都滿意,程序設(shè)計(jì)教科書一般也不會(huì)指定命名規(guī)則。但是制定一套令開發(fā)組成員基本滿意的命名規(guī)則,并在項(xiàng)目中貫徹實(shí)施,也是團(tuán)隊(duì)開發(fā)一項(xiàng)必不可少的工作。
我將我的團(tuán)隊(duì)的實(shí)際工作中的命名規(guī)則整理如下:
第一部分:共性規(guī)則
共有八項(xiàng)。作為指導(dǎo)供成員采納。
【規(guī)則1】標(biāo)識(shí)符應(yīng)簡單明了,望文知意。
標(biāo)識(shí)符采用英文單詞。切忌使用漢語拼音來命名。程序中的英文單詞一般不要太復(fù)雜,用詞應(yīng)當(dāng)準(zhǔn)確。例如不要把CurrentValue寫成NowValue。
盡量不要使用單詞縮寫或首字母縮寫。只有當(dāng)標(biāo)識(shí)符過長時(shí)才考慮使用單詞縮寫。在使用縮寫時(shí),不要自創(chuàng)縮寫,盡量使用被廣泛接受的縮寫。
【規(guī)則2】標(biāo)識(shí)符長度應(yīng)當(dāng)符合“min-length && max-information”原則。
一般的講,長名字能更好地表達(dá)含義,所以函數(shù)名、變量名、類名長達(dá)十幾個(gè)字符不足為怪。但是名字也不是越長越好。例如:變量名maxval就比maxValueUntilOverflow更好用。單字符的名字也是有用的,常見的如i,j,k,m,n,x,y,z等,它們通常用作函數(shù)內(nèi)的局部變量。
【規(guī)則3】命名規(guī)則盡量與所采用的操作系統(tǒng)或開發(fā)工具的風(fēng)格保持一致。
例如Windows應(yīng)用程序的標(biāo)識(shí)符通常采用“大小寫”混排的方式,如AddChild。而Unix應(yīng)用程序的標(biāo)識(shí)符通常采用“小寫加下劃線”的方式,如add_child。別把這兩類風(fēng)格混在一起用。
【規(guī)則4】程序中不要出現(xiàn)僅靠大小寫區(qū)分的標(biāo)識(shí)符。
例如:int x和int X;void foo() 和void FOO() 等。
【規(guī)則5】避免在不同級(jí)別的作用域中重名。
程序中不要出現(xiàn)標(biāo)識(shí)符完全相同的局部變量和全局變量,盡管兩者因作用域的不同而不會(huì)發(fā)生語法錯(cuò)誤,但會(huì)使人產(chǎn)生誤解。
【規(guī)則6】正確命名具有互斥意義的標(biāo)識(shí)符。
使用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)。
如:"MinValue"和"MaxValue","GetName()" 和 "SetName()"
【規(guī)則7】盡量避免名字中出現(xiàn)數(shù)字編號(hào)。
如Value1,Value2等,除非邏輯上的確需要編號(hào)。這是為了防止程序產(chǎn)生無意義的名字,降低程序的可讀性。
【規(guī)則8】使用庫標(biāo)志
在開發(fā)動(dòng)態(tài)庫時(shí),為了防止軟件庫中的一些標(biāo)識(shí)符和其它軟件庫中標(biāo)識(shí)符沖突,可以為各種標(biāo)識(shí)符加上能反映軟件性質(zhì)的前綴。
例如三維圖形標(biāo)準(zhǔn)OpenGL的所有庫函數(shù)均以gl開頭,所有常量(或宏定義)均以GL開頭。
第二部分:細(xì)則
我采用了一部分的“匈牙利”法命名規(guī)范,但沒有照搬。“匈牙利”法最大的特征就是類型前綴。例如:
int nNum = 0; // n 為類型信息,表明 nNum 是一個(gè) int 類型
class CUser; // C 為類型信息,表明 CUser 是一個(gè)類
但是正因?yàn)槿绱耍?/span>“匈牙利”法命名規(guī)范也給人一種繁瑣的感覺。例如:
int i, j, k;
float x, y, z;
倘若采用“匈牙利”命名規(guī)則,則應(yīng)當(dāng)寫成:
int iI, iJ, ik; // 前綴 i表示int類型
float fX, fY, fZ; // 前綴 f表示float類型
對(duì)于此類情況,我的處理方式是不加類型前綴。而對(duì)于下列情況我會(huì)加:
int iHeigh;
Bool bFlag;
總之,在我的命名規(guī)范中,類型前綴是一個(gè)可選的命名規(guī)則。下面分類進(jìn)行詳細(xì)的規(guī)范。
一、 類和接口
1、 命名:類名都以大寫字母“C”開頭,后跟一個(gè)或多個(gè)單詞。每個(gè)單詞的首字母要大寫。接口以大寫"I"開頭,代表Interface。
2、 組成形式:推薦用"名詞"或"形容詞+名詞"的形式,例如:"CAnalyzer", "CFastVector" ....
二、 函數(shù)
1、 命名:函數(shù)的名稱由一個(gè)或多個(gè)單詞組成。每個(gè)單詞的首字母要大寫。最長不得超過20個(gè)字符。
2、 組成形式:全局函數(shù)應(yīng)當(dāng)使用"動(dòng)詞"或者"動(dòng)詞+名詞"(動(dòng)賓詞組)的形式。例如:"gGetName()", " gDrawBox()"。
類成員函數(shù)應(yīng)當(dāng)只使用“動(dòng)詞”,被省略掉的名詞就是對(duì)象本身。例如:
" box->Draw();"。
3、 全局函數(shù):以小寫前綴"g"開頭。
4、 保護(hù)成員函數(shù):開頭應(yīng)當(dāng)加上一個(gè)下劃線“_”以示區(qū)別,例如:"_SetState()"
5、 私有成員函數(shù):開頭應(yīng)當(dāng)加上兩個(gè)下劃線“__”,例如:"__DestroyImp()"
6、 虛函數(shù):習(xí)慣以“Do”開頭,如:"DoRefresh()", "_DoEncryption()"
7、 回調(diào)和事件處理函數(shù) :習(xí)慣以單詞“On”開頭。例如:"_OnTimer()", "OnExit()"
三、 變量
變量是程序中使用最多的標(biāo)識(shí)符,變量的命名規(guī)范是一套C++命名規(guī)范中最重要的部分:
1、 命名:變量名由作用域前綴+類型前綴+一個(gè)或多個(gè)單詞組成。變量用小寫字母開頭的單詞組合而成,第二個(gè)單詞的首字母要大寫。例如:int nDrawMode。變量最長不得超過20個(gè)字符。
特殊的:對(duì)于某些用途簡單明了的局部變量,也可以使用簡化的方式,如:i, j, k, x, y, z
2、 組成形式:變量的名字應(yīng)當(dāng)使用"名詞"或者"形容詞+名詞"。例如:"nCode", "m_nState","nMaxWidth"," oldValue "," newValue "。
3、 作用域前綴:作用域前綴標(biāo)明一個(gè)變量的可見范圍。作用域可以有如下幾種:
前綴 | 說明 | 例子 |
無 | 局部變量 | |
m_ | 類的成員變量(member) | Int m_width |
ms_ | 類的靜態(tài)成員變量(static member) | static int ms_initValue; |
s_ | 靜態(tài)變量(static) | static int s_initValue; |
g_ | 外部全局變量(global) | int g_howManyPeople; |
sg_ | 靜態(tài)全局變量(static global) | |
gg_ | 進(jìn)程間共享的共享數(shù)據(jù)段全局變量(global global) | |
說明:作用域前綴不同于下面的類型前綴,應(yīng)該堅(jiān)決執(zhí)行。原因是:
1)變量作用域和鏈接性改變的情況是很少的,例如,很少的情況下會(huì)把一個(gè)成員變量改成靜態(tài)變量
2)編程中使用的工具常常不會(huì)直觀的顯示變量的作用域和鏈接性
4、 類型前綴:作用域前綴標(biāo)明一個(gè)變量的可見范圍。類型前綴標(biāo)明一個(gè)變量的類型,有如下幾種:
前綴 | 說明 | 例子 |
b | 布爾型變量(bool, BOOL) | bEnable |
ch | 字符型變量(char TCHAR) | chName |
lpsz | LPSTR、LPCSTR、LPCTSTR | lpszName |
n | 整型和位域變量(int, UINT,__int32,__int64) | nLength |
l | long | lOffset |
by | BYTE | |
w | WORD | wPos |
dw | DWORD | dwRange |
f | 浮點(diǎn)型變量(float) | |
d | double | |
p | 指針型變量和迭代子(pointer) | pDoc |
lp | 遠(yuǎn)指針 | |
e | 枚舉型變量(enumeration) | |
pfn | 特別針對(duì)指向函數(shù)的指針變量和函數(shù)對(duì)象指針(pointer of function) | |
g | 數(shù)組(grid) | |
h | handle Windows對(duì)象句柄 | hWnd |
四、 常量
常量名由類型前綴+全大寫字母組成,單詞間通過下劃線來界定,如:cDELIMITER, nMAX_BUFFER。類型前綴的定義與變量命名規(guī)則中的相同。
五、 結(jié)構(gòu)體、宏、枚舉變量、聯(lián)合體
全部由前綴+大寫字母組成,單詞間使用下劃線界定。
1、 結(jié)構(gòu)體:加小寫前綴"tag",之后以大寫字母開頭。
例:
typedef struct tagPOINT
{
int x;
int y;
} POINT;
2、 宏:大寫字母組成,單詞間使用下劃線界定
例:#define MAXNUMBER 100
3、 枚舉變量:加小寫前綴"enum"。
例:
typedef enum _FILE_OPEN_MODE
{
OPEN_READONLY,
OPEN_READWRITE
}FILE_OPEN_MODE;
4、 聯(lián)合體:加小寫前綴"uni"。
例:
typedef union _VARIANT
{
char unichVal;
int uninVal;
float uniftVal;
} VARIANT;