C++變數命名規則

淺談C++變數命名規則 不知道別的公司如何，反正我現在的公司對變數命名並沒有一定的規範，唯一要求就是能簡單易懂，但是，我想，這個多個程式員，大概每個人都有自己習慣的一套 命名規則吧，不過，要是並不通用的話，大概看別人的程式會很頭疼吧，SO 為了別人看偶的程式不至於太頭疼，偶決定找個通俗的命名法來參考下，於是，搜到了匈牙利命名法。。。 匈牙利命名法的來曆和介紹分類:C Plus Plus 匈牙利命名法是一種編程時的命名規範。基本原則是：變數名＝屬性＋類型＋對象描述，其中每一對象的名稱都要求有明確含義，可以取對象名字全稱或名字的一部 分。命名要基於容易記憶容易理解的原則。保證名字的連貫性是非常重要的。 舉例來說，表單的名稱為form，那麼在匈牙利命名法中可以簡寫為frm，則當表單變數名稱為Switchboard時，變數全稱應該為 frmSwitchboard。這樣可以很容易從變數名看出Switchboard是一個表單，同樣，如果此變數類型為標籤，那麼就應命名成 lblSwitchboard。可以看出，匈牙利命名法非常便於記憶，而且使變數名非常清晰易懂，這樣，增強了代碼的可讀性，方便各程式員之間相互交流代 碼。 這種命名技術是由一位能乾的Microsoft程式員查爾斯·西蒙尼(Charles Simonyi) 提出的，他出生在匈牙利。在 Microsoft 公司中和他一起工作的人被教會使用這種約定。這對他們來說一切都很正常。但對那些 Simonyi 領導的項目組之外的人來說卻感到很奇特，他們認為這是死板的表達方式，甚至說帶有這樣奇怪的外觀是因為它是用匈牙利文寫的。從此這種命名方式就被叫做匈牙 利命名法。 據說這種命名法是一位叫 Charles Simonyi 的匈牙利程式員發明的，後來他在微軟呆了幾年，於是 這種命名法就通過微軟的各種產品和文檔資料向世界傳播開了。現在，大部分程式員不管自己使用 什麼軟體進行開發，或多或少都使用了這種命名法。這種命名法的出發點是把量名變按：屬性+類型 +對象 描述的順序組合起來，以使程式員作變數時對變數的類型和其它屬性有直觀的瞭解， 下面 是HN變數命名規範，其中也有一些是我個人的偏向： 屬性部分: 全域變數 g_ 常量 c_ c++類成員變數 m_ 靜態變數 s_ 類型部分: 指標 p 函數 fn 無效 v 控制代碼 h 長整型 l 布爾 b 浮點型（有時也指檔案） f 雙字 dw 字串 sz 短整型 n 雙精確度浮點 d 計數 c（通常用cnt） 字元 ch（通常用c） 整型 i（通常用n） 位元組 by 字 w 實型 r 無符號 u 描述部分: 最大 Max 最小 Min 初始化 Init 臨時變數 T（或Temp） 來源物件 Src 目的對象 Dest 這裡順便寫幾個例子： hwnd ： h 是類型描述，表示控制代碼， wnd 是變數對象描述，表示視窗，所以 hwnd 表示視窗控制代碼； pfnEatApple ： pfn 是類型描述，表示指向函數的指標， EatApple 是變數對象描述，所以它表示 指向 EatApple 函數的函數指標變數。 g_cch ： g_ 是屬性描述，表示全域變數，c 和 ch 分別是計數類型和字元類型，一起表示變數類 型，這裡忽略了對象描述，所以它表示一個對字元進行計數的全域變數。 上面就是HN命名法的一般規則。 MFC、控制代碼、控制項及結構的命名規範 Windows類型 樣本變數 MFC類 樣本變數 HWND hWnd； CWnd* pWnd； HDLG hDlg； CDialog* pDlg； HDC hDC； CDC* pDC； HGDIOBJ hGdiObj； CGdiObject* pGdiObj； HPEN hPen； CPen* pPen； HBRUSH hBrush； CBrush* pBrush； HFONT hFont； CFont* pFont； HBITMAP hBitmap； CBitmap* pBitmap； HPALETTE hPaltte； CPalette* pPalette； HRGN hRgn； CRgn* pRgn； HMENU hMenu； CMenu* pMenu； HWND hCtl； CState* pState； HWND hCtl； CButton* pButton； HWND hCtl； CEdit* pEdit； HWND hCtl； CListBox* pListBox； HWND hCtl； CComboBox* pComboBox； HWND hCtl； CScrollBar* pScrollBar； HSZ hszStr； CString pStr； POINT pt； CPoint pt； SIZE size； CSize size； RECT rect； CRect rect； 一般首碼命名規範 首碼 類型 執行個體 C 類或結構 CDocument，CPrintInfo m_ 成員變數 m_pDoc，m_nCustomers 變數命名規範 首碼 類型 描述 執行個體 ch char 8位字元 chGrade ch TCHAR 如果_UNICODE定義，則為16位字元 chName b BOOL 布爾值 bEnable n int 整型（其大小依賴於作業系統） nLength n UINT 無符號值（其大小依賴於作業系統） nHeight w WORD 16位無符號值 wPos l LONG 32位有符號整型 lOffset dw DWORD 32位無符號整型 dwRange p * 指標 pDoc lp FAR* 遠指標 lpszName lpsz LPSTR 32位字串指標 lpszName lpsz LPCSTR 32位常量字串指標 lpszName lpsz LPCTSTR 如果_UNICODE定義，則為32位常量字串指標 lpszName h handle Windows物件控點 hWnd lpfn callback 指向CALLBACK函數的遠指標 首碼 符號類型 執行個體 範圍 IDR_ 不同類型的多個資源共用標識 IDR_MAIINFRAME 1～0x6FFF IDD_ 對話方塊資源 IDD_SPELL_CHECK 1～0x6FFF HIDD_ 對話方塊資源的Help上下文 HIDD_SPELL_CHECK 0x20001～0x26FF IDB_ 位元影像資源 IDB_COMPANY_LOGO 1～0x6FFF IDC_ 游標資源 IDC_PENCIL 1～0x6FFF IDI_ 表徵圖資源 IDI_NOTEPAD 1～0x6FFF ID_ 來自功能表項目或工具列的命令 ID_TOOLS_SPELLING 0x8000～0xDFFF HID_ 命令Help上下文 HID_TOOLS_SPELLING 0x18000～0x1DFFF IDP_ 訊息框提示 IDP_INVALID_PARTNO 8～0xDEEF HIDP_ 訊息框Help上下文 HIDP_INVALID_PARTNO 0x30008～0x3DEFF IDS_ 串資源 IDS_COPYRIGHT 1～0x7EEF IDC_ 對話方塊內的控制項 IDC_RECALC 8～0xDEEF Microsoft MFC宏命名規範 名稱 類型 _AFXDLL 唯一的動態串連庫（Dynamic Link Library，DLL）版本 _ALPHA 僅編譯DEC Alpha處理器 _DEBUG 包括診斷的調試版本 _MBCS 編譯多位元組字元集 _UNICODE 在一個應用程式中開啟Unicode AFXAPI MFC提供的函數 CALLBACK 通過指標回調的函數 庫標識符命名法 標識符 值和含義 u ANSI（N）或Unicode（U） d 調試或發行：D = 調試；忽略標識符為發行。 靜態庫版本命名規範 庫 描述NAFXCWD.LIB 調試版本：MFC靜態串連庫 NAFXCW.LIB 發行版本：MFC靜態串連庫 UAFXCWD.LIB 調試版本：具有Unicode支援的MFC靜態串連庫 UAFXCW.LIB 發行版本：具有Unicode支援的MFC靜態串連庫 動態串連庫命名規範 名稱 類型 _AFXDLL 唯一的動態串連庫（DLL）版本 WINAPI Windows所提供的函數 Windows.h中新的命名規範 類型 定義描述 WINAPI 使用在API聲明中的FAR PASCAL位置，如果正在編寫一個具有匯出API人口點的DLL，則可以在自己的API中使用該類型 CALLBACK 使用在應用程式回叫常式，如視窗和對話方塊過程中的FAR PASCAL的位置 LPCSTR 與LPSTR相同，只是LPCSTR用於唯讀串指標，其定義類似（const char FAR*） UINT 可移植的無符號整數型別，其大小由主機環境決定（對於Windows NT和Windows 9x為32位）；它是unsigned int的同義字 LRESULT 視窗程序傳回值的類型 LPARAM 聲明lParam所使用的類型，lParam是視窗程序的第四個參數 WPARAM 聲明wParam所使用的類型，wParam是視窗程序的第三個參數 LPVOID 一般指標類型，與（void *）相同，可以用來代替LPSTR 你可以通過這個連結引用該篇文章:http://wayllenzhang.bokee.com/tb.b?diaryId=12023505 char CHAR BYTE char szBuffer[] char szbuff_dest[] Init Ext CSting m_szPatID 第3章 命名規則 比較著名的命名規則當推Microsoft公司的“匈牙利”法，該命名規則的主要思想是“在變數和函數名中加入首碼以增進人們對程式的理解”。例如所有的字元變數均以ch為首碼，若是指標變數則追加首碼p。如果一個變數由ppch開頭，則表明它是指向字元指標的指標。 “匈牙利”法最大的缺點是煩瑣，例如 int i, j, k; float x, y, z; 倘若採用“匈牙利”命名規則，則應當寫成 int iI, iJ, ik; // 首碼 i表示int類型 float fX, fY, fZ; // 首碼 f表示float類型 如此煩瑣的程式會讓絕大多數程式員無法忍受。 據考察，沒有一種命名規則可以讓所有的程式員贊同，程式設計教科書一般都不指定命名規則。命名規則對軟體產品而言並不是“成敗悠關”的事，我們不要化太多精力試圖發明世界上最好的命名規則，而應當制定一種令大多數項目成員滿意的命名規則，並在項目中貫徹實施。 3.1 共性規則 本節論述的共性規則是被大多數程式員採納的，我們應當在遵循這些共性規則的前提下，再擴充特定的規則，如3.2節。 l 【規則3-1-1】標識符應當直觀且可以拼讀，可望文知意，不必進行“解碼”。 標識符最好採用英文單詞或其組合，便於記憶和閱讀。切忌使用漢語拼音來命名。程式中的英文單詞一般不會太複雜，用詞應當準確。例如不要把CurrentValue寫成NowValue。 l 【規則3-1-2】標識符的長度應當符合“min-length && max-information”原則。 幾十年前老ANSI C規定名字不準超過6個字元，現今的C++/C不再有此限制。一般來說，長名字能更好地表達含義，所以函數名、變數名、類名長達十幾個字元不足為怪。那麼 名字是否越長約好？不見得! 例如變數名maxval就比maxValueUntilOverflow好用。單字元的名字也是有用的，常見的如i,j,k,m,n,x,y,z等，它們 通常可用作函數內的局部變數。   l 【規則3-1-3】命名規則盡量與所採用的作業系統或開發工具的風格保持一致。 例如Windows應用程式的標識符通常採用“大小寫”混排的方式，如AddChild。而Unix應用程式的標識符通常採用“小寫加底線”的方式，如add_child。別把這兩類風格混在一起用。 l 【規則3-1-4】程式中不要出現僅靠大小寫區分的相似的標識符。 例如： int x, X; // 變數x 與 X 容易混淆 void foo(int x); // 函數foo 與FOO容易混淆 void FOO(float x);   l 【規則3-1-5】程式中不要出現標識符完全相同的局部變數和全域變數，儘管兩者的範圍不同而不會發生語法錯誤，但會使人誤解。 l 【規則3-1-6】變數的名字應當使用“名詞”或者“形容詞＋名詞”。 例如： float value; float oldValue; float newValue; l 【規則3-1-7】全域函數的名字應當使用“動詞”或者“動詞＋名詞”（動賓片語）。類的成員函數應當只使用“動詞”，被省略掉的名詞就是對象本身。 例如： DrawBox(); // 全域函數 box->Draw(); // 類的成員函數 l 【規則3-1-8】用正確的反義片語命名具有互斥意義的變數或相反動作的函數等。 例如： int minValue; int maxValue; int SetValue(…); int GetValue(…); 2 【建議3-1-1】盡量避免名字中出現數字編號，如Value1,Value2等，除非邏輯上的確需要編號。這是為了防止程式員偷懶，不肯為命名動腦筋而導致產生無意義的名字（因為用數字編號最省事）。 3.2 簡單的Windows應用程式命名規則 作者對“匈牙利”命名規則做了合理的簡化，下述的命名規則簡單易用，比較適合於Windows應用軟體的開發。 l 【規則3-2-1】類名和函數名用大寫字母開頭的單片語合而成。 例如： class Node; // 類名 class LeafNode; // 類名 void Draw(void); // 函數名 void SetValue(int value); // 函數名   l 【規則3-2-2】變數和參數用小寫字母開頭的單片語合而成。 例如： BOOL flag; int drawMode;   l 【規則3-2-3】常量全用大寫的字母，用底線分割單詞。 例如： const int MAX = 100; const int MAX_LENGTH = 100;   l 【規則3-2-4】靜態變數加首碼s_（表示static）。 例如： void Init(…) { static int s_initValue; // 靜態變數 … } l 【規則3-2-5】如果不得已需要全域變數，則使全域變數加首碼g_（表示global）。 例如： int g_howManyPeople; // 全域變數 int g_howMuchMoney; // 全域變數 l 【規則3-2-6】類的資料成員加首碼m_（表示member），這樣可以避免資料成員與成員函數的參數同名。 例如： void Object::SetValue(int width, int height) { m_width = width; m_height = height; }   l 【規則3-2-7】為了防止某一軟體庫中的一些標識符和其它軟體庫中的衝突，可以為各種標識符加上能反映軟體性質的首碼。例如三維圖形標準OpenGL的所有庫函數均以gl開頭，所有常量（或宏定義）均以GL開頭。