一、命名的兩個基本原則
1、含義清晰，不易混淆；
2、不和其它模塊、系統(tǒng)API的命名空間相沖突。
 
二、命名通則
1、在所有命名中，都應(yīng)使用標準的英文單詞或縮寫；不得使用拼音或拼音縮寫，除非該名字描述的是文
特有的內(nèi)容（如半角、全角、聲母、韻母等）；除非必要，不要用數(shù)字或較奇怪的字符來定義標識符。
2、所有命名都應(yīng)遵循達意原則，即名稱應(yīng)含義清晰、明確。
3、所有命名都不易過長，應(yīng)控制在規(guī)定的最大長度以內(nèi)。
4、所有命名都應(yīng)盡量使用全稱。
5、命名中若使用特殊約定或縮寫，則要有注釋說明。
6、自己特有的命名風格，要自始至終保持一致，不可來回變化。

說明：個人的命名風格，在符合所在項目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。（即命名規(guī)則中沒有規(guī)定到的地方才可有個人命名風格）。

7、在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標識符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，防止編譯、鏈接時產(chǎn)生沖突。
8、對于變量命名，禁止取單個字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。

說明：變量，尤其是局部變量，如果用單個字符表示，很容易敲錯（如i寫成j），而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費大量的查錯時間。
例：下面所示的局部變量名的定義方法可以借鑒。
int liv_Width
其變量名解釋如下：
l 局部變量（Local）  （其它：g全局變量（Global）...）
i 數(shù)據(jù)類型（Interger）
v 變量（Variable）   （其它：c常量（Const）...）
Width  變量含義
這樣可以防止局部變量與全局變量重名。

9、命名規(guī)范必須與所使用的系統(tǒng)風格保持一致，并在同一項目中統(tǒng)一，比如采用UNIX的全小寫加下劃線的風格或大小寫混排的方式，不要使用大小寫與下劃線混排的　  方式，用作特殊標識如標識成員變量或全局變量的m_和g_，其后加上大小寫混排的方式是允許的。
例： Add_User不允許，add_user、AddUser、m_AddUser允許。
說明：下面是一些在軟件中常用的反義詞組。

例：

11、除了編譯開關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用_EXAMPLE_TEST_之類以下劃線開始和結(jié)尾的定義。
12、程序中不要出現(xiàn)標識符完全相同的局部變量和全局變量，盡管兩者的作用域不同而不會發(fā)生語法錯誤，但會使人誤解。
 
三、具體規(guī)范
1、工程名
不強制統(tǒng)一。

2、文件名：
基于工程名，開頭3個字母應(yīng)表明與哪一個工程相關(guān)。
后面的字母應(yīng)能夠區(qū)別不同的功能。
不區(qū)分大小寫。
長度不限于8.3格式，建議不多于30個字符。
若文件用于定義和實現(xiàn)類，建議文件名與類名保持一致。

3、函數(shù)名：
參照 Windows API 的命名規(guī)范。
推薦使用動賓結(jié)構(gòu)。函數(shù)名應(yīng)清晰反映函數(shù)的功能、用途。
函數(shù)名最長不得超過30個字符。
函數(shù)名第一個字母必須大寫。
全局函數(shù)必須以小寫前綴"g"開頭。全局函數(shù)的名字應(yīng)當使用“動詞”或者“動詞＋名詞”（動賓詞組）。類的成員函數(shù)應(yīng)當只使用“動詞”，被省略掉的名詞就是對象本身。
例：
DrawBox(); // 全局函數(shù)
box->Draw(); // 類的成員函數(shù)

4、變量名：
原則上，變量名的命名遵從匈牙利記法。即：前綴 + 類型 + 變量名
變量名最長不得超過20個字符。
變量的名字應(yīng)當使用“名詞”或者“形容詞＋名詞”。
例：
  float value;
  float oldValue;
1）格式：[m_|s_|g_] type [class name|struct name] variable name
2）解釋：
  m_ ： 類的成員變量
  ms_：類的靜態(tài)成員變量
  s_ ：靜態(tài)全局變量
  g_ ：普通全局變量
  類型縮寫（type）
  char, TCHAR： ch
  char[]，TCHAR[]： sz
  bool, BOOL： b
  int, __int16,__int32,__int64： n
  long： l
  double： d
  float： ft
  BYTE： by
  WORD： w
  DWORD： dw
  unsigned： u
  function： fn
  p ：pointer
  lp ：pointer
5、類名：
必須以大寫"K"開頭，后面字母反映具體含義，以清晰表達類的用途和功能為原則。
接口必須以大寫"I"開頭，代表 Interface 。
當名稱由多個單詞構(gòu)成時，每一個單詞的第一個字母必須大寫。

6、結(jié)構(gòu)名、宏名、枚舉名、聯(lián)合名：
全部大寫。
枚舉名加小寫前綴"enum"。
例：

例：
#define defMAXNUMBER 100
  結(jié)構(gòu)名加小寫前綴"tag"，之后必須以大寫"K"開頭。
例：

聯(lián)合名加小寫前綴"uni"。
例：

說明：對接口部分的標識符應(yīng)該有更嚴格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上  “模塊”標識等。
說明：應(yīng)該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進行必要的注釋說明。
說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫。
一些單詞有大家公認的縮寫。
例：temp 可縮寫為 tmp

最新評論