匈牙利命名法

匈牙利命名法

匈牙利命名法是一種編程時的命名規範。基本原則是:變量名=屬性+類型+對象描述,其中每一對象的名稱都要求有明確含義,可以取對象名字全稱或名字的一部分。命名要基於容易記憶容易理解的原則。保證名字的連貫性是非常重要的。

舉例來說,表單的名稱爲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          *Rgn;
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

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章