1. 程式人生 > >C++程式碼規範之命名規則

C++程式碼規範之命名規則

一、命名的兩個基本原則
1、含義清晰,不易混淆;
2、不和其它模組、系統API的名稱空間相沖突。

二、命名通則
1、在所有命名中,都應使用標準的英文單詞或縮寫;不得使用拼音或拼音縮寫,除非該名字描述的是文
特有的內容(如半形、全形、聲母、韻母等);除非必要,不要用數字或較奇怪的字元來定義識別符號。
2、所有命名都應遵循達意原則,即名稱應含義清晰、明確。
3、所有命名都不易過長,應控制在規定的最大長度以內。
4、所有命名都應儘量使用全稱。
5、命名中若使用特殊約定或縮寫,則要有註釋說明。
6、自己特有的命名風格,要自始至終保持一致,不可來回變化。

說明:
個人的命名風格,在符合所在專案組或產品組的命名規則的前提下,才可使用。(即命名規則中沒有規定到的地方才可有個人命名風格)。

7、在同一軟體產品內,應規劃好介面部分識別符號(變數、結構、函式及常量)的命名,防止編譯、連結時產生衝突。
8、對於變數命名,禁止取單個字元(如i、j、k...),建議除了要有具體含義外,還能表明其變數型別、資料型別等,但i、j、k作區域性迴圈變數是允許的。

說明:
變數,尤其是區域性變數,如果用單個字元表示,很容易敲錯(如i寫成j),而編譯時又檢查不出來,有可能為了這個小小的錯誤而花費大量的查錯時間。
例:下面所示的區域性變數名的定義方法可以借鑑。
int liv_Width
其變數名解釋如下:
l 區域性變數(Local)  (其它:g全域性變數(Global)...)
i 資料型別(Interger)
v 變數(Variable)   (其它:c常量(Const)...)
Width  變數含義
這樣可以防止區域性變數與全域性變數重名。

9、命名規範必須與所使用的系統風格保持一致,並在同一專案中統一,比如採用UNIX的全小寫加下劃線的風格或大小寫混排的方式,不要使用大小寫與下劃線混排的   方式,用作特殊標識如標識成員變數或全域性變數的m_和g_,其後加上大小寫混排的方式是允許的。
例: Add_User不允許,add_user、AddUser、m_AddUser允許。
10、用正確的反義片語命名具有互斥意義的變數或相反動作的函式等。
說明:下面是一些在軟體中常用的反義片語。