C語言命名規(guī)范

C是一門樸素的語言，你使用的命名也應(yīng)該這樣。

然而，當(dāng)面對(duì)復(fù)雜情況時(shí)就有些棘手，給全局變量取一個(gè)描述性的名字是必要的。把一個(gè)全局函數(shù)叫做“foo”是一種目光短淺的行為。全局函數(shù)也一樣，如果你有一個(gè)統(tǒng)計(jì)當(dāng)前用戶個(gè)數(shù)的函數(shù)，應(yīng)當(dāng)把它命名為“count_active_user()”或者簡單點(diǎn)些的類似名稱，不應(yīng)該命名為“cntusr()”。

1 三種流行的命名法則

目前，業(yè)界共有四種命名法則：駝峰命名法、匈牙利命名法、帕斯卡命名法和下劃線命名法，其中前三種是較為流行的命名法。

(1)駝峰命令法。正如它的名稱所表示的那樣，是指混合使用大小寫字母來構(gòu)成變量和函數(shù)的名字，其實(shí)我們工作比較常用的就是駝峰命令法。例如，下面是分別用駱駝式命名法和下劃線法命名的同一個(gè)函數(shù)：

第一個(gè)函數(shù)名使用了駝峰命名法，函數(shù)名中的每一個(gè)邏輯斷點(diǎn)都有一個(gè)大寫字母來標(biāo)記。第二個(gè)函數(shù)名使用了下劃線法，函數(shù)名中的每一個(gè)邏輯斷點(diǎn)都有一個(gè)下劃線來標(biāo)記。

駝峰命名法近年來越來越流行了，在許多新的函數(shù)庫和Microsoft Windows這樣的環(huán)境中，它使用得當(dāng)相多。另一方面，下劃線法是C出現(xiàn)后開始流行起來的，在許多舊的程序和UNIX這樣的環(huán)境中，它的使用非常普遍。

(2)匈牙利命名法。廣泛應(yīng)用于象Microsoft Windows這樣的環(huán)境中。Windows 編程中用到的變量(還包括宏)的命名規(guī)則為匈牙利命名法，這種命名技術(shù)是由一位能干的 Microsoft 程序員查爾斯-西蒙尼(Charles Simonyi) 提出的。

匈牙利命名法通過在變量名前面加上相應(yīng)的小寫字母的符號(hào)標(biāo)識(shí)作為前綴，標(biāo)識(shí)出變量的作用域、類型等。這些符號(hào)可以多個(gè)同時(shí)使用，順序是先m_(成員變量)、再指針、再簡單數(shù)據(jù)類型、再其它。這樣做的好處在于能增加程序的可讀性，便于對(duì)程序的理解和維護(hù)。

例如：m_lpszStr, 表示指向一個(gè)以0字符結(jié)尾的字符串的長指針成員變量。

匈牙利命名法關(guān)鍵是：標(biāo)識(shí)符的名字以一個(gè)或者多個(gè)小寫字母開頭作為前綴；前綴之后的是首字母大寫的一個(gè)單詞或多個(gè)單詞組合，該單詞要指明變量的用途。

(3)帕斯卡(pascal)命名法。與駝峰命名法類似，二者的區(qū)別在于：駝峰命名法是首字母小寫，而帕斯卡命名法是首字母大寫，如：

二者都是采用了帕斯卡命名法。

(4)三種命名規(guī)則的小結(jié)：MyData就是一個(gè)帕斯卡命名的示例；MyData是一個(gè)駝峰命名法,它第一個(gè)單詞的第一個(gè)字母小寫,后面的單詞首字母大寫,看起來像一個(gè)駱駝；iMyData是一個(gè)匈牙利命名法,它的小寫的i說明了它的型態(tài)，后面的和帕斯卡命名相同，指示了該變量的用途。

2 命名的基本原則

(1)標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解——盡量采用采用英文單詞或全部中文全拼表示，若出現(xiàn)英文單詞和中文混合定義時(shí)，使用連字符“_”將英文與中文割開。較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個(gè)字母形成縮寫；一些單詞有大家公認(rèn)的縮寫。例如：temp->tmp、flag->標(biāo)志寄存器、statistic->stat、increment->inc、message->msg等縮寫能夠被大家基本認(rèn)可。

(2)命名中若使用特殊約定或縮寫，則要有注釋說明。應(yīng)該在源文件的開始之處，對(duì)文件中所使用的縮寫或約定，特別是特殊的縮寫，進(jìn)行必要的注釋說明。

(3)自己特有的命名風(fēng)格，要自始至終保持一致，不可來回變化。個(gè)人的命名風(fēng)格，在符合所在項(xiàng)目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。(即命名規(guī)則中沒有規(guī)定到的地方才可有個(gè)人命名風(fēng)格)。

(4)對(duì)于變量命名，禁止取單個(gè)字符(如i 、j 、k... )，建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i 、j 、k 作局部循環(huán)變量是允許的。變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)(如i寫成j)，而編譯時(shí)又檢查不出來，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。

(5)除非必要，不要用數(shù)字或較奇怪的字符來定義標(biāo)識(shí)符。

(6)命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一。

(7)在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識(shí)符(變量、結(jié)構(gòu)、函數(shù)及常量)的命名，防止編譯、鏈接時(shí)產(chǎn)生沖突。對(duì)接口部分的標(biāo)識(shí)符應(yīng)該有更嚴(yán)格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上“模塊”標(biāo)識(shí)等。

(8)用正確的反義詞組命名具有互斥意義的變量或函數(shù)等。

下面是一些在軟件中常用的反義詞組。

\

示例：

(9)除了編譯開關(guān)/ 頭文件等特殊應(yīng)用，應(yīng)避免使用EXAMPLE_TEST 之類以下劃線開始和結(jié)尾的定義。

3 變量名的命名規(guī)則

(1)變量的命名規(guī)則要求用“匈牙利法則”。

即開頭字母用變量的類型，其余部分用變量的英文意思、英文的縮寫、中文全拼或中文全拼的縮寫,要求單詞的第一個(gè)字母應(yīng)大寫。

即：變量名=變量類型+變量的英文意思(或英文縮寫、中文全拼、中文全拼縮寫)

對(duì)非通用的變量，在定義時(shí)加入注釋說明，變量定義盡量可能放在函數(shù)的開始處：

bool 用b開頭 b標(biāo)志寄存器

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結(jié)尾的字符串 用sz開頭 szFileName

(2)指針變量命名的基本原則為：

對(duì)一重指針變量的基本原則為：“p”+變量類型前綴+命名，如一個(gè)float*型應(yīng)該表示為pfStat。對(duì)二重指針變量的基本規(guī)則為：“pp”+變量類型前綴+命名。對(duì)三重指針變量的基本規(guī)則為：“ppp”+變量類型前綴+命名。

(3)全局變量用g_開頭,如一個(gè)全局的長型變量定義為g_lFailCount。即：變量名=g_+變量類型+變量的英文意思(或縮寫)。此規(guī)則還可避免局部變量和全局變量同名而引起的問題。

(4)靜態(tài)變量用s_開頭,如一個(gè)靜態(tài)的指針變量定義為s_plPerv_Inst。即：變量名=s_+變量類型+變量的英文意思(或縮寫)

(5)對(duì)枚舉類型(enum)中的變量，要求用枚舉變量或其縮寫做前綴。并且要求用大寫。如：

(6)對(duì)struct、union變量的命名要求定義的類型用大寫。并要加上前綴，其內(nèi)部變量的命名規(guī)則與變量命名規(guī)則一致。

結(jié)構(gòu)一般用S開頭，如：

聯(lián)合體一般用U開頭，如:

(7)對(duì)常量(包括錯(cuò)誤的編碼)命名，要求常量名用大寫，常量名用英文表達(dá)其意思。當(dāng)需要由多個(gè)單詞表示時(shí)，單詞與單詞之間必須采用連字符“_”連接。

如：#define CM_FILE_NOT_FOUND CMMAKEHR(0X20B) 其中CM表示類別。

(8)對(duì)const 的變量要求在變量的命名規(guī)則前加入c_。即：c_+變量命名規(guī)則；示例：const char* c_szFileName;

4 函數(shù)的命名規(guī)范

(1)函數(shù)的命名應(yīng)該盡量用英文(或英文縮寫、中文全拼、中文全拼縮寫)表達(dá)出函數(shù)完成的功能——函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能。遵循動(dòng)賓結(jié)構(gòu)的命名法則，函數(shù)名中動(dòng)詞在前,并在命名前加入函數(shù)的前綴，函數(shù)名的長度不得少于8個(gè)字母。函數(shù)名首字大寫，若包含有兩個(gè)單詞的每個(gè)單詞首字母大寫。如果是OOP 方法，可以只有動(dòng)詞(名詞是對(duì)象本身)。示例：

(2)避免使用無意義或含義不清的動(dòng)詞為函數(shù)命名。如使用process、handle等為函數(shù)命名，因?yàn)檫@些動(dòng)詞并沒有說明要具體做什么。

(3)必須使用函數(shù)原型聲明。函數(shù)原型聲明包括：引用外來函數(shù)及內(nèi)部函數(shù)，外部引用必須在右側(cè)注明函數(shù)來源：模塊名及文件名；內(nèi)部函數(shù)，只要注釋其定義文件名——和調(diào)用者在同一文件中(簡單程序)時(shí)不需要注釋。

應(yīng)確保每個(gè)函數(shù)聲明中的參數(shù)的名稱、類型和定義中的名稱、類型一致。

5 函數(shù)參數(shù)命名規(guī)范

(1)參數(shù)名稱的命名參照變量命名規(guī)范。

(2)為了提高程序的運(yùn)行效率，減少參數(shù)占用的堆棧，傳遞大結(jié)構(gòu)的參數(shù)，一律采用指針或引用方式傳遞。

(3)為了便于其他程序員識(shí)別某個(gè)指針參數(shù)是入口參數(shù)還是出口參數(shù)，同時(shí)便于編譯器檢查錯(cuò)誤，應(yīng)該在入口參數(shù)前加入const標(biāo)志。

如：……cmCopyString(const CHAR * c_szSource, CHAR * szDest)

6 文件名

(包括動(dòng)態(tài)庫、組件、控件、工程文件等)的命名規(guī)范文件名的命名要求表達(dá)出文件的內(nèi)容，要求文件名的長度不得少于5個(gè)字母，嚴(yán)禁使用象file1,myfile之類的文件名。

老九學(xué)堂出品，轉(zhuǎn)載請(qǐng)私信哦

對(duì)于文章內(nèi)容有不理解的可以添加老九君個(gè)人QQ：614940318，請(qǐng)備注來自簡書

老九學(xué)堂免費(fèi)C、C++、Java課程地址：

https://study.163.com/courses-search?keyword=%E8%80%81%E4%B9%9D%E5%AD%A6%E5%A0%82