C語言命名規範

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

然而，當面對複雜情況時就有些棘手，給全局變量取一個描述性的名字是必要的。把一個全局函數叫做“foo”是一種目光短淺的行為。全局函數也一樣，如果你有一個統計當前用戶個數的函數，應當把它命名為“count_active_user()”或者簡單點些的類似名稱，不應該命名為“cntusr()”。

1 三種流行的命名法則

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

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

第一個函數名使用了駝峰命名法，函數名中的每一個邏輯斷點都有一個大寫字母來标記。第二個函數名使用了下劃線法，函數名中的每一個邏輯斷點都有一個下劃線來标記。

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

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

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

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

匈牙利命名法關鍵是：标識符的名字以一個或者多個小寫字母開頭作為前綴；前綴之後的是首字母大寫的一個單詞或多個單詞組合，該單詞要指明變量的用途。

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

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

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

2 命名的基本原則

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

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

(3)自己特有的命名風格，要自始至終保持一緻，不可來回變化。個人的命名風格，在符合所在項目組或産品組的命名規則的前提下，才可使用。(即命名規則中沒有規定到的地方才可有個人命名風格)。

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

(5)除非必要，不要用數字或較奇怪的字符來定義标識符。

(6)命名規範必須與所使用的系統風格保持一緻，并在同一項目中統一。

(7)在同一軟件産品内，應規劃好接口部分标識符(變量、結構、函數及常量)的命名，防止編譯、鍊接時産生沖突。對接口部分的标識符應該有更嚴格限制，防止沖突。如可規定接口部分的變量與常量之前加上“模塊”标識等。

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

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

示例：

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

3 變量名的命名規則

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

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

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

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

bool 用b開頭 b标志寄存器

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*型應該表示為pfStat。對二重指針變量的基本規則為：“pp” 變量類型前綴 命名。對三重指針變量的基本規則為：“ppp” 變量類型前綴 命名。

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

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

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

(6)對struct、union變量的命名要求定義的類型用大寫。并要加上前綴，其内部變量的命名規則與變量命名規則一緻。

結構一般用S開頭，如：

聯合體一般用U開頭，如:

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

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

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

4 函數的命名規範

(1)函數的命名應該盡量用英文(或英文縮寫、中文全拼、中文全拼縮寫)表達出函數完成的功能——函數名應準确描述函數的功能。遵循動賓結構的命名法則，函數名中動詞在前,并在命名前加入函數的前綴，函數名的長度不得少于8個字母。函數名首字大寫，若包含有兩個單詞的每個單詞首字母大寫。如果是OOP 方法，可以隻有動詞(名詞是對象本身)。示例：

(2)避免使用無意義或含義不清的動詞為函數命名。如使用process、handle等為函數命名，因為這些動詞并沒有說明要具體做什麼。

(3)必須使用函數原型聲明。函數原型聲明包括：引用外來函數及内部函數，外部引用必須在右側注明函數來源：模塊名及文件名；内部函數，隻要注釋其定義文件名——和調用者在同一文件中(簡單程序)時不需要注釋。

應确保每個函數聲明中的參數的名稱、類型和定義中的名稱、類型一緻。

5 函數參數命名規範

(1)參數名稱的命名參照變量命名規範。

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

(3)為了便于其他程序員識别某個指針參數是入口參數還是出口參數，同時便于編譯器檢查錯誤，應該在入口參數前加入const标志。

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

6 文件名

(包括動态庫、組件、控件、工程文件等)的命名規範文件名的命名要求表達出文件的内容，要求文件名的長度不得少于5個字母，嚴禁使用象file1,myfile之類的文件名。

需要更多學習筆記幹貨的小夥伴、歡迎關注公衆号【老九學堂】（づ￣3￣）づ╭❤～

更多精彩资讯请关注tft每日頭條，我们将持续为您更新最新资讯!