C++代碼規(guī)范之命名規(guī)則
一、命名的兩個(gè)基本原則
1、含義清晰，不易混淆；
2、不和其它模塊、系統(tǒng)API的命名空間相沖突。
二、命名通則
1、在所有命名中，都應(yīng)使用標(biāo)準(zhǔn)的英文單詞或縮寫；不得使用拼音或拼音縮寫，除非該名字描述的是文
特有的內(nèi)容（如半角、全角、聲母、韻母等）；除非必要，不要用數(shù)字或較奇怪的字符來定義標(biāo)識(shí)符。
2、所有命名都應(yīng)遵循達(dá)意原則，即名稱應(yīng)含義清晰、明確。
3、所有命名都不易過長(zhǎng)，應(yīng)控制在規(guī)定的最大長(zhǎng)度以內(nèi)。
4、所有命名都應(yīng)盡量使用全稱。
5、命名中若使用特殊約定或縮寫，則要有注釋說明。
6、自己特有的命名風(fēng)格，要自始至終保持一致，不可來回變化。
說明：個(gè)人的命名風(fēng)格，在符合所在項(xiàng)目組或產(chǎn)品組的命名規(guī)則的前提下，才可使用。（即命名規(guī)則中沒有規(guī)定到的地方才可有個(gè)人命名風(fēng)格）。
7、在同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標(biāo)識(shí)符（變量、結(jié)構(gòu)、函數(shù)及常量）的命名，防止編譯、鏈接時(shí)產(chǎn)生沖突。
8、對(duì)于變量命名，禁止取單個(gè)字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。
說明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)（如i寫成j），而編譯時(shí)又檢查不出來，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。
例：下面所示的局部變量名的定義方法可以借鑒。
int liv_Width
其變量名解釋如下：
l 局部變量（Local） （其它：g全局變量（Global）...）
i 數(shù)據(jù)類型（Interger）
v 變量（Variable） （其它：c常量（Const）...）
Width 變量含義
這樣可以防止局部變量與全局變量重名。
9、命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一，比如采用UNIX的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的 方式，用作特殊標(biāo)識(shí)如標(biāo)識(shí)成員變量或全局變量的m_和g_，其后加上大小寫混排的方式是允許的。
例： Add_User不允許，add_user、AddUser、m_AddUser允許。
說明：下面是一些在軟件中常用的反義詞組。
add / remove begin / end create / destroy insert / delete
first / last get / releaseincrement / decrement put / get
add / delete lock / unlockopen / closemin / max
old / newstart / stopnext / previoussource / target
show / hide send / receive up / downcut / paste
例：
int min_sum;
int max_sum;
int add_user( BYTE *user_name );
int delete_user( BYTE *user_name );
11、除了編譯開關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用_EXAMPLE_TEST_之類以下劃線開始和結(jié)尾的定義。
12、程序中不要出現(xiàn)標(biāo)識(shí)符完全相同的局部變量和全局變量，盡管兩者的作用域不同而不會(huì)發(fā)生語(yǔ)法錯(cuò)誤，但會(huì)使人誤解。
三、具體規(guī)范
1、工程名
不強(qiáng)制統(tǒng)一。
2、文件名：
基于工程名，開頭3個(gè)字母應(yīng)表明與哪一個(gè)工程相關(guān)。
后面的字母應(yīng)能夠區(qū)別不同的功能。
不區(qū)分大小寫。
長(zhǎng)度不限于8.3格式，建議不多于30個(gè)字符。
若文件用于定義和實(shí)現(xiàn)類，建議文件名與類名保持一致。
3、函數(shù)名：
參照 Windows API 的命名規(guī)范。
推薦使用動(dòng)賓結(jié)構(gòu)。函數(shù)名應(yīng)清晰反映函數(shù)的功能、用途。
函數(shù)名最長(zhǎng)不得超過30個(gè)字符。
函數(shù)名第一個(gè)字母必須大寫。
全局函數(shù)必須以小寫前綴"g"開頭。全局函數(shù)的名字應(yīng)當(dāng)使用“動(dòng)詞”或者“動(dòng)詞＋名詞”（動(dòng)賓詞組）。類的成員函數(shù)應(yīng)當(dāng)只使用“動(dòng)詞”，被省略掉的名詞就是對(duì)象本身。
例：
DrawBox(); // 全局函數(shù)
box->Draw(); // 類的成員函數(shù)
4、變量名：
原則上，變量名的命名遵從匈牙利記法。即：前綴 + 類型 + 變量名
變量名最長(zhǎng)不得超過20個(gè)字符。
變量的名字應(yīng)當(dāng)使用“名詞”或者“形容詞＋名詞”。
例：
float value;
float oldValue;
1）格式：[m_|s_|g_] type [class name|struct name] variable name
2）解釋：
m_ ： 類的成員變量
ms_：類的靜態(tài)成員變量
s_ ：靜態(tài)全局變量
g_ ：普通全局變量
類型縮寫（type）
char, TCHAR： ch
char[]，TCHAR[]： sz
bool, BOOL： b
int, __int16,__int32,__int64： n
long： l
double： d
float： ft
BYTE： by
WORD： w
DWORD： dw
unsigned： u
function： fn
p ：pointer
lp ：pointer
5、類名：
必須以大寫"K"開頭，后面字母反映具體含義，以清晰表達(dá)類的用途和功能為原則。
接口必須以大寫"I"開頭，代表 Interface 。
當(dāng)名稱由多個(gè)單詞構(gòu)成時(shí)，每一個(gè)單詞的第一個(gè)字母必須大寫。
6、結(jié)構(gòu)名、宏名、枚舉名、聯(lián)合名：
全部大寫。
枚舉名加小寫前綴"enum"。
例：
typedef enum _KFILE_OPEN_MODE
{
enumOPEN_READONLY = 0;
enumOPEN_READWRITE = 1;
enumCREATE_ALWAY = 3 ;
} KFILE_OPEN_MODE;
宏名加小寫前綴"def"。
例：
#define defMAXNUMBER 100
結(jié)構(gòu)名加小寫前綴"tag"，之后必須以大寫"K"開頭。
例：
typedef struct tagKPOINT
{
int x;
int y;
} KPOINT;
聯(lián)合名加小寫前綴"uni"。
例：
typedef union _VARIANT
{
char unichVal;
int uninVal;
long unilVal;
float uniftVal;
} VARIANT;
說明：對(duì)接口部分的標(biāo)識(shí)符應(yīng)該有更嚴(yán)格限制，防止沖突。如可規(guī)定接口部分的變量與常量之前加上 “模塊”標(biāo)識(shí)等。
說明：應(yīng)該在源文件的開始之處，對(duì)文件中所使用的縮寫或約定，特別是特殊的縮寫，進(jìn)行必要的注釋說明。
說明：較短的單詞可通過去掉“元音”形成縮寫；較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫。
一些單詞有大家公認(rèn)的縮寫。
例：temp 可縮寫為 tmp
flag 可縮寫為 flg
statistic 可縮寫為 stat
increment 可縮寫為 inc
message 可縮寫為 msg
相關(guān)文章
C語(yǔ)言實(shí)現(xiàn)第一次防死版掃雷游戲
大家好，本篇文章主要講的是C語(yǔ)言實(shí)現(xiàn)第一次防死版掃雷游戲，感興趣的同學(xué)趕快來看一看吧，對(duì)你有幫助的話記得收藏一下2022-01-01
使用VC進(jìn)行圖像處理的時(shí)候，CBitmap類為我們提供了豐富的位圖處理函數(shù)，本文總結(jié)了該類的相關(guān)函數(shù)和常用使用方法，包括加載位圖，顯示位圖，析構(gòu)CBitmap資源以及在內(nèi)存中保存位圖等內(nèi)容。2015-11-11
本文主要介紹了C++索引越界的解決方法，文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2021-08-08
這篇文章主要為大家詳細(xì)介紹了OpenGL中點(diǎn)Bresenham繪制直線算法，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-02-02
這篇文章主要介紹了北郵考研復(fù)試C語(yǔ)言上機(jī)題目精選,摘自2010年北郵CS的復(fù)試,需要的朋友可以參考下2015-08-08
Qt實(shí)現(xiàn)http服務(wù)的示例代碼
這篇文章將為大家詳細(xì)講解有關(guān)Qt如何實(shí)現(xiàn)http服務(wù)，小編覺得挺實(shí)用的，因此分享給大家做個(gè)參考，希望大家閱讀完這篇文章后可以有所收獲2023-04-04
這篇文章主要為大家詳細(xì)介紹了C語(yǔ)言返回值指針的函數(shù)，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助2022-02-02
C++ OpenCV實(shí)現(xiàn)銀行卡號(hào)識(shí)別功能
這篇文章主要介紹了如何使用OpenCV C++實(shí)現(xiàn)銀行卡號(hào)識(shí)別功能，文中的示例代碼講解詳細(xì)，對(duì)我們學(xué)習(xí)OpenCV有一定幫助，需要的可以參考一下2022-01-01
C語(yǔ)言實(shí)現(xiàn)字符串轉(zhuǎn)浮點(diǎn)函數(shù)的示例
字符串不僅可以轉(zhuǎn)換為整數(shù)，也可以轉(zhuǎn)換為浮點(diǎn)數(shù)，本文主要介紹了C語(yǔ)言實(shí)現(xiàn)字符串轉(zhuǎn)浮點(diǎn)函數(shù)的示例，具有一定的參考價(jià)值，感興趣的可以了解一下2022-02-02
下面小編就為大家?guī)硪黄嘘P(guān)C++頭文件的包含順序研究。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-01-01