前言

這篇重點(diǎn)介紹一下代碼編程的命名規(guī)范，主要是業(yè)界流行的命名法則和標(biāo)識(shí)符命名規(guī)范

標(biāo)識(shí)符的命名規(guī)則歷來(lái)是一個(gè)敏感話題，典型的命名風(fēng)格如unix風(fēng)格、windows風(fēng)格等，從來(lái)無(wú)法達(dá)成共識(shí)。實(shí)際上，各種風(fēng)格都有其優(yōu)勢(shì)也有其劣勢(shì)，而且往往和個(gè)人的審美觀有關(guān)。對(duì)標(biāo)識(shí)符定義主要是為了讓團(tuán)隊(duì)的代碼看起來(lái)盡可能統(tǒng)一，有利于代碼的后續(xù)閱讀和修改。

命名完全體現(xiàn)了程序的可閱讀性和可理解性，在一定程度上是不需要寫注釋也能看懂代碼。

命名法則介紹

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

1printEmployeePaychecks// 駝峰命名法                                 
2
3print_employee_paychecks//下劃線命名法
4
5PrintEmployeePaychecks// 帕斯卡命名法

其中，駝峰命名法和帕斯卡命名法類似，但是區(qū)別在第一個(gè)字母是否大小寫，因此駝峰命名法一般稱小駝峰命名法，帕斯卡命名法稱大駝峰命名法。

駝峰命名法

正如它的名稱所表示的那樣，是指混合使用大小寫字母來(lái)構(gòu)成變量和函數(shù)的名字（這樣的變量名看上去就像駱駝峰一樣此起彼伏，故得名），又叫小駝峰命名法。

當(dāng)變量名或函數(shù)名是由一個(gè)或多個(gè)單詞連結(jié)在一起，而構(gòu)成的唯一識(shí)別字時(shí)，第一個(gè)單詞以小寫字母開(kāi)始；從第二個(gè)單詞開(kāi)始以后的每個(gè)單詞的首字母都采用大寫字母。

1printEmployeePaychecks

匈牙利命名法

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

匈牙利命名法的規(guī)則是：作用域（屬性）+類型+描述。

如：定義一個(gè)全局變量，指向類型為int的最小值指針，變量命名為

int g_pMinValue = NULL;

以下是我根據(jù)匈牙利命名法總結(jié)的的寫法對(duì)應(yīng)表

有看過(guò)我代碼的朋友可能就會(huì)有疑問(wèn)了，為什么我寫的代碼中關(guān)于變量的定義，特別是整數(shù)型的變量沒(méi)有加前綴uc us ui c s i l ，而其它類型變量都會(huì)加上前綴，原因如下：

1. 雖然這個(gè)一看名字就知道這個(gè)變量的類型定義和取值范圍，但是通常情況下變量定義后在后面的維護(hù)中可能為了增大或減少取值范圍，會(huì)改變類型的定義，但又不同時(shí)重命名變量，導(dǎo)致后來(lái)再看就會(huì)有異議
2. 目前的大部分編程軟件將鼠標(biāo)放置在變量上，通常就會(huì)提示該變量的類型定義，所以也不需要特意按照這個(gè)命名
3. 大部分只有整數(shù)型的變量定義后才會(huì)因?yàn)槿≈捣秶芟薅淖冾愋投x，而其他類型的定義之后基本不會(huì)隨意變動(dòng)

帕斯卡命名法

是指混合使用大小寫字母來(lái)構(gòu)成變量和函數(shù)的名字，每個(gè)單詞的第一個(gè)字母都大寫，又叫大駝峰式命名法；

1PrintEmployeePaychecks

下劃線命名法

使用下劃線（ ）連接組成的標(biāo)識(shí)符，即 單詞（字母或數(shù)字） 單詞（字母或數(shù)字）_單詞（字母或數(shù)字）

1print_employee_paychecks(); // 函數(shù)
2int min_value = 0;   // 變量

標(biāo)識(shí)符命名規(guī)范

根據(jù)不同場(chǎng)景使用不同命名規(guī)則，甚至組合使用，業(yè)內(nèi)比較常用的方式。

文件名

駝峰命名法，有時(shí)也使用下劃線命名法，根據(jù)不同情況使用，盡量和之前的保持一致

因?yàn)椴煌到y(tǒng)對(duì)文件名大小寫處理會(huì)有所不同（如Windows系統(tǒng)不區(qū)分大小寫，但是Linux系統(tǒng)則區(qū)分）

變量名

匈牙利命名法 + （?。劮迕▋煞N結(jié)合使用

具體規(guī)則是：屬性+類型+描述（ 駝峰命名法）

1. 使用名詞或者形容詞 + 名詞方式命名變量（描述），如char szFile[20] = "file";int fileSize = 0;
2. 禁止使用單字節(jié)命名變量，但允許定義 i、j、k 等作為局部循環(huán)變量

宏定義/枚舉

大寫 + 下劃線命名法

1. 對(duì)于數(shù)值或者字符串等等常量或者枚舉的定義，全部采用全大寫字母，單詞之間加下劃線“_”的方式命名。如 #define MIN_VALUE 5
2. 除了頭文件或編譯開(kāi)關(guān)等特殊標(biāo)識(shí)符定義，宏定義不能使用下劃線“_”開(kāi)頭和結(jié)尾（一般來(lái)說(shuō)，下劃線開(kāi)頭或結(jié)尾的宏都是一些內(nèi)部的定義）

函數(shù)名

帕斯卡命名法（大駝峰命名法），對(duì)于對(duì)外提供的接口函數(shù)，則加模塊前綴

1. 以函數(shù)要執(zhí)行的動(dòng)作命名，一般采用動(dòng)詞或者動(dòng)詞+名詞的結(jié)構(gòu)，且符合帕斯卡命名法
2. 對(duì)于對(duì)外提供的接口函數(shù)，一般加上模塊前綴LED_，如LED_CtrlOff(…)

通用規(guī)則

除了上述規(guī)則外，關(guān)于以上標(biāo)識(shí)符的命名還應(yīng)該符合以下規(guī)則:

1、標(biāo)識(shí)符的命名要清晰、明了，有明確的含義，同時(shí)使用完整的單詞或大家基本可以認(rèn)同和理解的縮寫，避免讓人產(chǎn)生誤解

如：良好的命名：int error_number; 不好的命名：int n, nerr;

2、標(biāo)識(shí)符的長(zhǎng)度應(yīng)當(dāng)符合“min-length && max-information”原則

如：幾十年前老ANSI C規(guī)定名字不準(zhǔn)超過(guò)6個(gè)字符，現(xiàn)今的C++/C不再有此限制。一般來(lái)說(shuō)，長(zhǎng)名字能更好地表達(dá)含義，所以函數(shù)名、變量名、類名長(zhǎng)達(dá)十幾個(gè)字符不足為怪。那么名字是否越長(zhǎng)越好？不一定，例如變量名maxval就比maxValueUntilOverflow好用

3、除了常見(jiàn)的通用縮寫外，不使用單詞縮寫，不得使用漢語(yǔ)拼音

較短的單詞可以通過(guò)去掉“元音”形成縮寫，較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫，一些單詞有大家公認(rèn)的縮寫，常用單詞縮寫必須統(tǒng)一。協(xié)議中的單詞縮寫與協(xié)議保持一致，對(duì)于某個(gè)系統(tǒng)使用的專用縮寫應(yīng)該在注釋或者某處做統(tǒng)一說(shuō)明

4、用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的函數(shù)等

如：add/remove，begin/end，creat/destroy等

5、盡量避免名字中出現(xiàn)數(shù)字編號(hào)，除非邏輯上的確需要編號(hào)

6、重構(gòu)/修改部分代碼時(shí)，應(yīng)保持和原有代碼風(fēng)格保持一致

根據(jù)源代碼現(xiàn)有的風(fēng)格繼續(xù)編寫代碼，有利于保持總體一致