在軟體開發這一高度抽象而且十分複雜的活動中,命名規則的重要性更顯得尤為突出。一套定義良好並且完整的、在整個項目中統一使用的命名規範將大大提升原始碼的可讀性和軟體的可維護性。
在引入細節之前,先說明一下命名規範的整體原則:
|
同一性 |
在編寫一個子模組或衍生類別的時候,要遵循其基類或整體模組的命名風格,保持命名風格在整個模組中的同一性。 |
|
標識符組成 |
標識符採用英文單詞或其組合,應當直觀且可以拼讀,可望文知意,用詞應當準確。 |
|
最小化長度 && 最大化資訊量原則 |
在保持一個標識符意思明確的同時,應當盡量縮短其長度。 |
|
避免過於相似 |
不要出現僅靠大小寫區分的相似的標識符,例如“i”與“I”,“function”與“Function”等等。 |
|
避免在不同層級的範圍中重名 |
程式中不要出現名字完全相同的局部變數和全域變數,儘管兩者的範圍不同而不會發生語法錯誤,但容易使人誤解。 |
|
正確命名具有互斥意義的標識符 |
用正確的反義片語命名具有互斥意義的標識符,如:"nMinValue"和"nMaxValue","GetName()" 和 "SetName()" .... |
|
避免名字中出現數字編號 |
盡量避免名字中出現數字編號,如Value1,Value2等,除非邏輯上的確需要編號。這是為了防止程式員偷懶,不肯為命名動腦筋而導致產生無意義的名字(因為用數字編號最省事)。 |
類/結構
|
除了異常類等個別情況(不希望使用者把該類看作一個普通的、正常的類之情況)外,C++類/結構
的命名應該遵循以下準則:
|
C++類/結構的命名 |
類的名稱都要以大寫字母“C”開頭,後跟一個或多個單詞。為便於界定,每個單詞的首字母要大寫。 |
|
推薦的組成形式 |
類的命名推薦用"名詞"或"形容詞+名詞"的形式,例如:"CAnalyzer", "CFastVector" .... |
不同於C++類的概念,傳統的C結構體只是一種將一組資料捆綁在一起的方式。傳統C結構體的命名規則為:
|
傳統C結構體的命名 |
傳統C結構體的名稱全部由大寫字母組成,單詞間使用底線界定,例如:"SERVICE_STATUS", "DRIVER_INFO" .... |
|
函數
|
函數的命名 |
函數的名稱由一個或多個單片語成。為便於界定,每個單詞的首字母要大寫。 |
|
推薦的組成形式 |
函數名應當使用"動詞"或者"動詞+名詞"(動賓片語)的形式。例如:"GetName()", "SetValue()", "Erase()", "Reserve()" .... |
|
保護成員函數 |
保護成員函數的開頭應當加上一個底線“_”以示區別,例如:"_SetState()" .... |
|
私人成員函數 |
類似地,私人成員函數的開頭應當加上兩個底線“__”,例如:"__DestroyImp()" .... |
|
虛函數 |
虛函數習慣以“Do”開頭,如:"DoRefresh()", "_DoEncryption()" .... |
|
回調和事件處理函數 |
回調和事件處理函數習慣以單詞“On”開頭。例如:"_OnTimer()", "OnExit()" .... |
|
常量
|
C++中引入了對常量的支援,常量的命名規則如下:
|
常量的命名 |
常量名由類型首碼+全大寫字母組成,單詞間通過底線來界定,如:cDELIMITER, nMAX_BUFFER ....
類型首碼的定義與變數命名規則中的相同。 |
|
枚舉、聯合、typedef
|
枚舉、聯合及typedef語句都是定義新類型的簡單手段,它們的命名規則為:
|
枚舉、聯合、typedef的命名 |
枚舉、聯合、typedef語句產生的類型名由全大寫字母組成,單詞間通過底線來界定,如:FAR_PROC, ERROR_TYPE .... |
|
宏、枚舉值
|
宏、枚舉值的命名 |
宏和枚舉值由全大寫字母組成,單詞間通過底線來界定,如:ERROR_UNKNOWN, OP_STOP .... |
|
變數
|
變數應該是程式中使用最多的標識符了,變數的命名規範可能是一套C++命名準則中最重要的部分:
|
變數的命名 |
變數名由範圍首碼+類型首碼+一個或多個單片語成。為便於界定,每個單詞的首字母要大寫。
對於某些用途簡單明了的局部變數,也可以使用簡化的方式,如:i, j, k, x, y, z .... |
|
範圍首碼 |
範圍首碼標明一個變數的可見範圍。範圍可以有如下幾種:
|
首碼 |
說明 |
|
無 |
局部變數 |
|
m_ |
類的成員變數(member) |
|
sm_ |
類的靜態成員變數(static member) |
|
s_ |
靜態變數(static) |
|
g_ |
外部全域變數(global) |
|
sg_ |
靜態全域變數(static global) |
|
gg_ |
進程間共用的共用資料區段全域變數(global global) |
除非不得已,否則應該儘可能少使用全域變數。 |
|
類型首碼 |
類型首碼標明一個變數的類型,可以有如下幾種:
|
首碼 |
說明 |
|
n |
整型和位域變數(number) |
|
e |
枚舉型變數(enumeration) |
|
c |
字元型變數(char) |
|
b |
布爾型變數(bool) |
|
f |
浮點型變數(float) |
|
p |
指標型變數和迭代子(pointer) |
|
pfn |
特別針對指向函數的指標變數和函數對象指標(pointer of function) |
|
g |
數組(grid) |
|
i |
類的執行個體(instance)
對於經常用到的類,也可以定義一些專門的首碼,如:std::string和std::wstring類的首碼可以定義為"st",std::vector類的首碼可以定義為"v"等等。 |
類型首碼可以組合使用,例如"gc"表示字元數組,"ppn"表示指向整型的指標的指標等等。 |
|
推薦的組成形式 |
變數的名字應當使用"名詞"或者"形容詞+名詞"。例如:"nCode", "m_nState","nMaxWidth" .... |
|