C是一門樸素的語言，你使用的命名也應該這樣。與Modula-2和Pascal程序員不同，C程序員不使用諸如“ThisVariableIsATemporaryCounter”這樣“聰明”的名字。C程序員應該叫它“tmp”，這寫起來更簡單，也不會更難懂。
然而，當面對復雜情況時就有些棘手，給全局變量取一個描述性的名字是必要的。把一個全局函數(shù)叫做“foo”是一種目光短淺的行為。全局函數(shù)也一樣，如果你有一個統(tǒng)計當前用戶個數(shù)的函數(shù)，應當把它命名為“count_active_user()”或者簡單點些的類似名稱，不應該命名為“cntusr()”。
3.1 三種流行的命名法則
目前，業(yè)界共有四種命名法則：駝峰命名法、匈牙利命名法、帕斯卡命名法和下劃線命名法，其中前三種是較為流行的命名法。
(1)駝峰命令法。正如它的名稱所表示的那樣，是指混合使用大小寫字母來構(gòu)成變量和函數(shù)的名字。例如，下面是分別用駱駝式命名法和下劃線法命名的同一個函數(shù)：
printEmployeePaychecks()；
print_employee_paychecks()；
第一個函數(shù)名使用了駝峰命名法，函數(shù)名中的每一個邏輯斷點都有一個大寫字母來標記。第二個函數(shù)名使用了下劃線法，函數(shù)名中的每一個邏輯斷點都有一個下劃線來標記。
駝峰命名法近年來越來越流行了，在許多新的函數(shù)庫和Microsoft Windows這樣的環(huán)境中，它使用得當相多。另一方面，下劃線法是C出現(xiàn)后開始流行起來的，在許多舊的程序和UNIX這樣的環(huán)境中，它的使用非常普遍。
(2)匈牙利命名法。廣泛應用于象Microsoft Windows這樣的環(huán)境中。Windows 編程中用到的變量(還包括宏)的命名規(guī)則為匈牙利命名法，這種命名技術是由一位能干的 Microsoft 程序員查爾斯-西蒙尼(Charles Simonyi) 提出的。
匈牙利命名法通過在變量名前面加上相應的小寫字母的符號標識作為前綴，標識出變量的作用域、類型等。這些符號可以多個同時使用，順序是先m_(成員變量)、再指針、再簡單數(shù)據(jù)類型、再其它。這樣做的好處在于能增加程序的可讀性，便于對程序的理解和維護。
例如：m_lpszStr, 表示指向一個以0字符結(jié)尾的字符串的長指針成員變量。
匈牙利命名法關鍵是：標識符的名字以一個或者多個小寫字母開頭作為前綴；前綴之后的是首字母大寫的一個單詞或多個單詞組合，該單詞要指明變量的用途。
(3)帕斯卡(pascal)命名法。與駝峰命名法類似，二者的區(qū)別在于：駝峰命名法是首字母小寫，而帕斯卡命名法是首字母大寫，如：
DisplayInfo();
string UserName;
二者都是采用了帕斯卡命名法。
(4)三種命名規(guī)則的小結(jié)：MyData就是一個帕斯卡命名的示例；myData是一個駝峰命名法,它第一個單詞的第一個字母小寫,后面的單詞首字母大寫,看起來像一個駱駝；iMyData是一個匈牙利命名法,它的小寫的i說明了它的型態(tài)，后面的和帕斯卡命名相同，指示了該變量的用途。
3.2 命名的基本原則
(1)標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解——盡量采用采用英文單詞或全部中文全拼表示，若出現(xiàn)英文單詞和中文混合定義時，使用連字符“_”將英文與中文割開。較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫；一些單詞有大家公認的縮寫。例如：temp->tmp、flag->flg、statistic->stat、increment->inc、message->msg等縮寫能夠被大家基本認可。
(2)命名中若使用特殊約定或縮寫，則要有注釋說明。應該在源文件的開始之處，對文件中所使用的縮寫或約定，特別是特殊的縮寫，進行必要的注釋說明。
(3)自己特有的命名風格，要自始至終保持一致，不可來回變化。個人的命名風格，在符合所在項目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。(即命名規(guī)則中沒有規(guī)定到的地方才可有個人命名風格)。
(4)對于變量命名，禁止取單個字符(如i 、j 、k... )，建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i 、j 、k 作局部循環(huán)變量是允許的。變量，尤其是局部變量，如果用單個字符表示，很容易敲錯(如i寫成j)，而編譯時又檢查不出來，有可能為了這個小小的錯誤而花費大量的查錯時間。
(5)除非必要，不要用數(shù)字或較奇怪的字符來定義標識符。
(6)命名規(guī)范必須與所使用的系統(tǒng)風格保持一致，并在同一項目中統(tǒng)一。
(7)在同一軟件產(chǎn)品內(nèi)，應規(guī)劃好接口部分標識符(變量、結(jié)構(gòu)、函數(shù)及常量)的命名，防止編譯、鏈接時產(chǎn)生沖突。對接口部分的標識符應該有更嚴格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上“模塊”標識等。
(8)用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等。
下面是一些在軟件中常用的反義詞組。
add / remove begin / end create / destroy
insert / delete first / last g et / 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
示例：
int min_sum;
int max_sum;
int add_user( BYTE *user_name );
int delete_user( BYTE *user_name );
(9)除了編譯開關/ 頭文件等特殊應用，應避免使用_EXAMPLE_TEST_ 之類以下劃線開始和結(jié)尾的定義。
3.3 變量名的命名規(guī)則
(1)變量的命名規(guī)則要求用“匈牙利法則”。
即開頭字母用變量的類型，其余部分用變量的英文意思、英文的縮寫、中文全拼或中文全拼的縮寫,要求單詞的第一個字母應大寫。
即： 變量名=變量類型+變量的英文意思(或英文縮寫、中文全拼、中文全拼縮寫)
對非通用的變量，在定義時加入注釋說明，變量定義盡量可能放在函數(shù)的開始處。
見下表：
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結(jié)尾的字符串 用sz開頭 szFileName
(2)指針變量命名的基本原則為：
對一重指針變量的基本原則為：“p”+變量類型前綴+命名，如一個float*型應該表示為pfStat。對二重指針變量的基本規(guī)則為：“pp”+變量類型前綴+命名。對三重指針變量的基本規(guī)則為：“ppp”+變量類型前綴+命名。
(3)全局變量用g_開頭,如一個全局的長型變量定義為g_lFailCount。即：變量名=g_+變量類型+變量的英文意思(或縮寫)。此規(guī)則還可避免局部變量和全局變量同名而引起的問題。
(4)靜態(tài)變量用s_開頭,如一個靜態(tài)的指針變量定義為s_plPerv_Inst。即： 變量名=s_+變量類型+變量的英文意思(或縮寫)
(5)對枚舉類型(enum)中的變量，要求用枚舉變量或其縮寫做前綴。并且要求用大寫。如：
enum cmEMDAYS
{
EMDAYS_MONDAY;
EMDAYS_TUESDAY;
……
};
(6)對struct、union變量的命名要求定義的類型用大寫。并要加上前綴，其內(nèi)部變量的命名規(guī)則與變量命名規(guī)則一致。
結(jié)構(gòu)一般用S開頭，如：
struct ScmNPoint
{
int nX;//點的X位置
int nY; //點的Y位置
};
聯(lián)合體一般用U開頭，如:
union UcmLPoint
{
LONG lX;
LONG lY;
}
(7)對常量(包括錯誤的編碼)命名，要求常量名用大寫，常量名用英文表達其意思。當需要由多個單詞表示時，單詞與單詞之間必須采用連字符“_”連接。
如：#define CM_FILE_NOT_FOUND CMMAKEHR(0X20B) 其中CM表示類別。
(8)對const 的變量要求在變量的命名規(guī)則前加入c_。即：c_+變量命名規(guī)則；示例：const char* c_szFileName;
3.4 函數(shù)的命名規(guī)范
(1)函數(shù)的命名應該盡量用英文(或英文縮寫、中文全拼、中文全拼縮寫)表達出函數(shù)完成的功能——函數(shù)名應準確描述函數(shù)的功能。遵循動賓結(jié)構(gòu)的命名法則，函數(shù)名中動詞在前,并在命名前加入函數(shù)的前綴，函數(shù)名的長度不得少于8個字母。函數(shù)名首字大寫，若包含有兩個單詞的每個單詞首字母大寫。如果是OOP 方法，可以只有動詞(名詞是對象本身)。示例：
LONG GetDeviceCount(……);
void print_record( unsigned int rec_ind ) ;
int input_record( void ) ;
unsigned char get_current_color( void ) ;
(2)避免使用無意義或含義不清的動詞為函數(shù)命名。如使用process、handle等為函數(shù)命名，因為這些動詞并沒有說明要具體做什么。
(3)必須使用函數(shù)原型聲明。函數(shù)原型聲明包括：引用外來函數(shù)及內(nèi)部函數(shù)，外部引用必須在右側(cè)注明函數(shù)來源： 模塊名及文件名；內(nèi)部函數(shù)，只要注釋其定義文件名——和調(diào)用者在同一文件中(簡單程序)時不需要注釋。
應確保每個函數(shù)聲明中的參數(shù)的名稱、類型和定義中的名稱、類型一致。
3.5 函數(shù)參數(shù)命名規(guī)范
(1)參數(shù)名稱的命名參照變量命名規(guī)范。
(2)為了提高程序的運行效率，減少參數(shù)占用的堆棧，傳遞大結(jié)構(gòu)的參數(shù)，一律采用指針或引用方式傳遞。
(3)為了便于其他程序員識別某個指針參數(shù)是入口參數(shù)還是出口參數(shù)，同時便于編譯器檢查錯誤，應該在入口參數(shù)前加入const標志。
如：……cmCopyString(const CHAR * c_szSource, CHAR * szDest)
3.6 文件名(包括動態(tài)庫、組件、控件、工程文件等)的命名規(guī)范
文件名的命名要求表達出文件的內(nèi)容，要求文件名的長度不得少于5個字母，嚴禁使用象file1,myfile之類的文件名。
|
QQ好友和群
QQ空間
騰訊微博
騰訊朋友
收藏
淘帖
頂
踩
