编程命名法则
來源：C語言命名規則_柳旭輝的博客-CSDN博客_c語言命名規則
命名法則
目前，業界共有四種命名法則：駝峰命名法、匈牙利命名法、帕斯卡命名法和下劃線命名法，其中前三種較為流行。
（1）駝峰命名法
駝峰命名法是指混合使用大小寫字母來構成變量和函數的名字，函數名中的每一個邏輯斷點都有一個大寫字母來標記。
例如：printMessageName（）；
用途：駝峰命名法近年來越來越流行了，在許多新的函數庫和Microsoft Windows這樣的環境中，它使用得相當多。
(2)匈牙利命名法
匈牙利命名法通過在變量名前面加上相應的小寫字母的符號標識作為前綴，標識出變量的作用域、類型等。這些符號可以多個同時使用，順序是先m_(成員變量)、再指針、再簡單數據類型、再其它。這樣做的好處在于能增加程序的可讀性，便于對程序的理解和維護。標識符的名字以一個或者多個小寫字母開頭作為前綴；前綴之后的是首字母大寫的一個單詞或多個單詞組合，該單詞要指明變量的用途。
例如：iNameCount;
用途：廣泛應用于像Microsoft Windows這樣的環境中。Windows 編程中用到的變量(還包括宏)的命名規則為匈牙利命名法。
(3)帕斯卡(pascal)命名法
與駝峰命名法類似，二者的區別在于：駝峰命名法是首字母小寫，而帕斯卡命名法是首字母大寫。
例如：PrintMessageName（）；
(4) 下劃線命名法
下劃線命名法，是指混合使用大小寫字母來構成變量和函數的名字。函數名中的每一個邏輯斷點都有一個下劃線來標記。下劃線法是C出現后開始流行起來的，在許多舊的程序和UNIX這樣的環境中，它的使用非常普遍。
例如：print_message_name（）；
四種命名規則的小結：
MyData就是一個帕斯卡命名的示例；myData是一個駝峰命名法,它第一個單詞的第一個字母小寫,后面的單詞首字母大寫,看起來像一個駱駝；iMyData是一個匈牙利命名法,它的小寫的i說明了它的型態，后面的和帕斯卡命名相同，指示了該變量的用途。my_data則是下劃線命名法。
命名的基本原則
(1) 標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產生誤解。
盡量采用采用英文單詞或全部中文全拼表示，若出現英文單詞和中文混合定義時，使用連字符“_”將英文與中文割開。較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫；一些單詞有大家公認的縮寫。例如：temp->tmp、flag->flg、statistic->stat、increment->inc、message->msg等縮寫能夠被大家基本認可。
(2) 命名中若使用特殊約定或縮寫，則要有注釋說明。
應該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進行必要的注釋說明。
(3) 自己特有的命名風格，要自始至終保持一致，不可來回變化。
個人的命名風格，在符合所在項目組或產品組的命名規則的前提下，才可使用。(即命名規則中沒有規定到的地方才可有個人命名風格)。
(4) 對于變量命名，禁止取單個字符(如i 、j 、k… )，建議除了要有具體含義外，還能表明其變量類型、數據類型等，但i 、j 、k 作局部循環變量是允許的。
變量，尤其是局部變量，如果用單個字符表示，很容易敲錯(如i寫成j)，而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費大量的查錯時間。
(5) 除非必要，不要用數字或較奇怪的字符來定義標識符。
(6) 命名規范必須與所使用的系統風格保持一致，并在同一項目中統一。
(7) 在同一軟件產品內，應規劃好接口部分標識符(變量、結構、函數及常量)的命名，防止編譯、鏈接時產生沖突。
對接口部分的標識符應該有更嚴格限制，防止沖突。如可規定接口部分的變量與常量之前加上“模塊”標識等。
(8)用正確的反義詞組命名具有互斥意義的變量或相反動作的函數等。
下面是一些在軟件中常用的反義詞組。
add / remove begin / end create / destroy
insert / delete first / last get / release
increment / decrement put / get
add / delete lock / unlock open / close
min / max old / new start / stop
next / previous source / target show / hide
send / receive source / destination
cut / paste up / down
(9)除了編譯開關/ 頭文件等特殊應用，應避免使用EXAMPLE_TEST 之類以下劃線開始和結尾的定義。
變量名的命名規則
(1) 變量的命名規則要求用“匈牙利法則”。
即開頭字母用變量的類型，其余部分用變量的英文意思、英文的縮寫、中文全拼或中文全拼的縮寫,要求單詞的第一個字母應大寫。
即： 變量名=變量類型+變量的英文意思(或英文縮寫、中文全拼、中文全拼縮寫)
對非通用的變量，在定義時加入注釋說明，變量定義盡量可能放在函數的開始處。
見下表：
bool 用b開頭 bFlg
int 用i開頭 iCount
short int 用n開頭 nStepCount
long int 用l開頭 lSum
char 用c開頭 cCount
unsigned char 用by開頭
float 用f開頭 fAvg
double 用d開頭 dDeta
unsigned int(WORD) 用w開頭 wCount
unsigned long int(DWORD) 用dw開頭 dwBroad
字符串 用s開頭 sFileName
用0結尾的字符串 用sz開頭 szFileName
(2) 指針變量命名的基本原則
對一重指針變量的基本原則為：“p”+變量類型前綴+命名。如一個float * 型應該表示為pfState。
對二重指針變量的基本規則為：“pp”+變量類型前綴+命名。如一個float **型應該表示為ppfState。
對三重指針變量的基本規則為：“ppp”+變量類型前綴+命名。
(3) 全局變量用g_開頭
如一個全局的長型變量定義為g_lFailCount。
即：變量名=g_+變量類型+變量的英文意思(或縮寫)。此規則還可避免局部變量和全局變量同名而引起的問題。
(4) 靜態變量用s_開頭
如一個靜態的指針變量定義為s_plPerv_Inst。即： 變量名=s_+變量類型+變量的英文意思(或縮寫)
(5) 對枚舉類型(enum)中的變量，要求用枚舉變量或其縮寫做前綴。并且要求用大寫。
如：
enum cmEMDAYS
{
EMDAYS_MONDAY;
EMDAYS_TUESDAY;
……
};
(6) 對struct、union變量的命名要求定義的類型用大寫。并要加上前綴，其內部變量的命名規則與變量命名規則一致。
結構一般用S開頭，如：
struct ScmNPoint
{
int nX;//點的X位置
int nY; //點的Y位置
};
聯合體一般用U開頭，如:
union UcmLPoint
{
LONG lX;
LONG lY;
}
(7) 對常量(包括錯誤的編碼)命名，要求常量名用大寫，常量名用英文表達其意思。當需要由多個單詞表示時，單詞與單詞之間必須采用連字符“_”連接。
如：#define CM_FILE_NOT_FOUND CMMAKEHR(0X20B) 其中CM表示類別。
(8) 對const 的變量要求在變量的命名規則前加入c_。
即：c_+變量命名規則；示例：const char* c_szFileName;
函數的命名規范
(1) 函數的命名應該盡量用英文(或英文縮寫、中文全拼、中文全拼縮寫)表達出函數完成的功能——函數名應準確描述函數的功能。
遵循動賓結構的命名法則，函數名中動詞在前,并在命名前加入函數的前綴，函數名的長度不得少于8個字母。
函數名首字大寫，若包含有兩個單詞的每個單詞首字母大寫。如果是OOP 方法，可以只有動詞(名詞是對象本身)。示例：
LONG GetDeviceCount(……);
void print_record( unsigned int rec_ind ) ;
int input_record( void ) ;
unsigned char get_current_color( void ) ;
(2) 避免使用無意義或含義不清的動詞為函數命名。
如使用process、handle等為函數命名，因為這些動詞并沒有說明要具體做什么。
(3) 必須使用函數原型聲明。
函數原型聲明包括：引用外來函數及內部函數，外部引用必須在右側注明函數來源： 模塊名及文件名；內部函數，只要注釋其定義文件名——和調用者在同一文件中(簡單程序)時不需要注釋。
應確保每個函數聲明中的參數的名稱、類型和定義中的名稱、類型一致。
函數參數的命名規范
(1)參數名稱的命名參照變量命名規范。
(2)為了提高程序的運行效率，減少參數占用的堆棧，傳遞大結構的參數，一律采用指針或引用方式傳遞。
(3)為了便于其他程序員識別某個指針參數是入口參數還是出口參數，同時便于編譯器檢查錯誤，應該在入口參數前加入const標志。
如：……cmCopyString(const char * c_szSource, char * szDest)
一些命名約定
命令規范基本上采用了微軟推薦的匈牙利命名法，略有簡化。
1． 常量
常量由大寫字母和數字組成，中間可以下劃線分隔，如 CPU_8051。
程序中少出現無意義的數字，常量盡量用宏替代。
2． 變量
變量由小寫（變量類型）字母開頭，中間以大寫字母分隔，可以添加變量域前綴（變量活動域前綴以下劃線分隔）。
如果變量名的含義十分明顯，則不加前綴，避免煩瑣。如用于循環的int型變量 i,j,k ；float 型的三維坐標（x,y,z）等。
3．函數名
函數命名采用動賓形式。如果函數為最底層，可以考慮用全部小寫，單詞間采用帶下劃線的形式。如底層圖形函數：pixel、lineto以及讀鍵盤函數get_key 等。
4． 符號名應該通用或者有具體含義，可讀性強。尤其是全局變量，靜態變量含義必須清晰。
C++中的一些關鍵詞不能作為符號名使用，如class、new、friend等。符號名長度小于31個，與ANSI C 保持一致。命名只能用26個字母，10個數字，以及下劃線‘’來組成，不要使用‘$’‘@’等符號。下劃線‘’使用應該醒目，不能出現在符號的頭尾，只能出現在符號中間，且不要連續出現兩個。
————————————————
版權聲明：本文為CSDN博主「柳旭輝」的原創文章，遵循CC 4.0 BY-SA版權協議，轉載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/xuhui_liu/article/details/72726063
總結
- 上一篇： 后端语言对比
- 下一篇： Activiti源码 之 DataMan