C++变量命名手册-阿里云开发者社区

开发者社区> 杨粼波> 正文

C++变量命名手册

简介:
+关注继续查看
几年以前,Charles Simonyi(他后来成为微软的著名程序员)设计了一种以前缀为基础的命名方法,这种方法后来称为"匈牙利表示法"以记念他.他的思想是根据每个标识符所代表的含义给它一个前缀.微软后来采用了这个思想,给每个标识符一个前缀以说明它的数据类型.因此,整型变量的前缀是n,长整型变量是nl,字符型数组变量是ca,以及字符串(以空类型结尾的字符数组)以sz为前缀.这些名字可能会非常古怪.比如说:lpszFoo表示"Foo"是一个指向以空字符为结尾的字符串的长整型指针.



这种方法的优点是使人能够通过变量的名字来辨别变量的类型,而不比去查找它的定义.遗憾的是,这种方法不仅使变量名字非常绕口,而且使改变变量类型的工作变得十分艰巨.在Windows3.1中,整型变量为16为宽.如果我们在开始时采用了一个整型变量,但是在通过30---40个函数的计算之后,发现采用整型变量宽度不够,这时我们不仅要改变这个变量的类型,而且要改变这个变量在这30--40个函数中的名字.



因为不切实际,除了一些顽固的Windows程序员外已经没有人再使用"匈牙利表示法"了.毫无疑问,在某种场合它依然存在,但大部分人现在已经抛弃它了.一般而言,输入前缀是一种糟糕的想法,因为它把变量于其类型紧紧地绑在了一起.

对于30行以下的函数,匈牙利方法一般有优势。

尤其是对界面编程,有优势。

但对于有强烈的算法要求、尤其是有很多抽象类型的C++程序,匈牙利方法简直是一个灾难。

看你用在什么地方。

现在有了很好的IDE工具,如:VC,SourceInsight等.

选中变量,会自动提示告诉你它的声明和定义,这样

匈牙利命名法就没有很大的必要了.

无非就是为了程序可读性较好.

实际上良好的代码书写习惯比强制使用匈牙利命名法更重要.

系统性。整体性。可读性。分类要清楚。要有注释!



匈牙利命名法是微软推广的一种关于变量、函数、对象、前缀、宏定义等各种类型的符号的命名规范。匈牙利命名法的主要思想是:在变量和函数名中加入前缀以增进人们对程序的理解。它是由微软内部的一个匈牙利人发起使用的,结果它在微软内部逐渐流行起来,并且推广给了全世界的Windows开发人员。下面将介绍匈牙利命名法,后面的例子里也会尽量遵守它和上面的代码风格。还是那句话,并不是要求所有的读者都要去遵守,但是希望读者作为一个现代的软件开发人员都去遵守它。





a     Array                       数组

b     BOOL (int)                   布尔(整数)

by     Unsigned Char (Byte)             无符号字符(字节)

c     Char                       字符(字节)

cb     Count of bytes                 字节数

cr     Color reference value           颜色(参考)值

cx     Count of x (Short)             x的集合(短整数)

dw     DWORD   (unsigned long)           双字(无符号长整数)

f     Flags   (usually multiple bit values)   标志(一般是有多位的数值)

fn     Function                     函数

g_     global                     全局的

h     Handle                     句柄

i     Integer                     整数

l     Long                       长整数

lp     Long pointer                 长指针

m_     Data member of a class           一个类的数据成员

n     Short int                   短整数

p     Pointer                     指针

s     String                     字符串

sz     Zero terminated String           以0结尾的字符串

tm     Text metric                   文本规则

u     Unsigned int                 无符号整数

ul     Unsigned long (ULONG)           无符号长整数

w     WORD (unsigned short)           无符号短整数

x,y   x, y coordinates (short)         坐标值/短整数

v     void                       空







有关项目的全局变量用g_开始,类成员变量用m_,局部变量若函数较大则可考虑用l_用以显示说明其是局部变量。



前缀     类型     例子

g_   全局变量     g_Servers

C   类或者结构体     CDocument,CPrintInfo

m_   成员变量     m_pDoc,m_nCustomers



VC常用前缀列表:



前缀     类型     描述     例子

ch   char 8位字符   chGrade

ch   TCHAR     16位UNICODE类型字符     chName

b   BOOL     布尔变量     bEnabled

n   int   整型(其大小由操作系统决定)     nLength

n   UINT     无符号整型(其大小由操作系统决定)     nLength

w   WORD     16位无符号整型   wPos

l     LONG     32位有符号整型   lOffset

dw   DWORD     32位无符号整型     dwRange

p   *     Ambient memory model pointer 内存模块指针,指针变量   pDoc

lp   FAR*     长指针     lpDoc

lpsz LPSTR     32位字符串指针     lpszName

lpsz LPCSTR     32位常量字符串指针     lpszName

lpsz LPCTSTR     32位UNICODE类型常量指针     lpszName

h   handle     Windows对象句柄     hWnd

lpfn (*fn)()     回调函数指针 Callback Far pointer to CALLBACK function     lpfnAbort



Windows对象名称缩写:



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     hPalette;     CPalette*     pPalette; 

HRGN   hRgn;     CRgn*     pRgn; 

HMENU hMenu;     CMenu*     pMenu; 

HWND   hCtl;     CStatic*     pStatic; 

HWND   hCtl;     CButton*     pBtn;

HWND   hCtl;     CEdit*     pEdit; 

HWND   hCtl;     CListBox*     pListBox;

HWND   hCtl;     CComboBox*     pComboBox;



VC常用宏定义命名列表:



前缀     符号类型     符号例子     范围

IDR_     标识多个资源共享的类型     IDR_MAINFRAME     1~0x6FFF

IDD_     对话框资源(Dialog)     IDD_SPELL_CHECK     1~ 0x6FFF

HIDD_   基于对话框的上下文帮助     HIDD_SPELL_CHECK     0x20001~0x26FF

IDB_     位图资源(Bitmap)     IDB_COMPANY_LOGO     1~0x6FFF

IDC_     光标资源(Cursor)     IDC_PENCIL   1~0x6FFF

IDI_     图标资源(Icon)     IDI_NOTEPAD 1~0x6FFF

ID_、IDM_     工具栏或菜单栏的命令项     ID_TOOLS_SPELLING     0x8000~0xDFFF

HID_     命令上下文帮助     HID_TOOLS_SPELLING     0x18000~0x1DFFF

IDP_     消息框提示文字资源     IDP_INVALID_PARTNO     8~0xDFFF

HIDP_   消息框上下文帮助     HIDP_INVALID_PARTNO     0x30008~0x3DFFF

IDS_     字符串资源(String)     IDS_COPYRIGHT     1~0x7FFF

IDC_     对话框内的控制资源     IDC_RECALC   8~0xDFFF



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 



MSDN中给出了一段遵守代码风格和匈牙利命名法的代码参考如下:



None.gif 1    #include “sy.h”
None.gif
None.gif 2     extern   int   * rgwDic;
None.gif
None.gif 3     extern   int  bsyMac;
None.gif
None.gif 4     struct  SY  * PsySz( char  sz[])
None.gif
ExpandedBlockStart.gif 6     {
InBlock.gif
InBlock.gif 7         char   * pch;
InBlock.gif
InBlock.gif 8       int  cch;
InBlock.gif
InBlock.gif 9       struct  SY  * psy,  * PsyCreate();
InBlock.gif
InBlock.gif 10       int   * pbsy;
InBlock.gif
InBlock.gif 11       int  cwSz;
InBlock.gif
InBlock.gif 12      unsigned wHash = 0 ;
InBlock.gif
InBlock.gif 13      pch = sz;
InBlock.gif
InBlock.gif 14       while  ( * pch != 0 )
InBlock.gif
InBlock.gif 15        wHash = wHash <> 11 +* pch ++ ;
InBlock.gif
InBlock.gif 16      cch = pch - sz;
InBlock.gif
InBlock.gif 17      pbsy =& rgbsyHash[(wHash & 077777 ) % cwHash];
InBlock.gif
InBlock.gif 18       for  (;  * pbsy != 0 ; pbsy  =   & psy -> bsyNext)
InBlock.gif
ExpandedSubBlockStart.gif 19       {
InBlock.gif
InBlock.gif 20         char   * szSy;
InBlock.gif
InBlock.gif 21        szSy =  (psy = ( struct  SY * ) & rgwDic[ * pbsy]) -> sz;
InBlock.gif
InBlock.gif 22        pch = sz;
InBlock.gif
InBlock.gif 23         while  ( * pch ==* szSy ++ )
InBlock.gif
ExpandedSubBlockStart.gif 24         {
InBlock.gif
InBlock.gif 25           if  ( * pch ++== 0 )
InBlock.gif
InBlock.gif 26             return  (psy);
InBlock.gif
ExpandedSubBlockEnd.gif 27        } 

InBlock.gif 
ExpandedSubBlockEnd.gif 28      } 

InBlock.gif 
InBlock.gif 29      cwSz = 0 ;
InBlock.gif
InBlock.gif 30       if  (cch >= 2 )
InBlock.gif
InBlock.gif 31        cwSz = cch - 2 / sizeof ( int ) + 1 ;
InBlock.gif
InBlock.gif 32       * pbsy = ( int   * )(psy = PsyCreate(cwSY + cwSz)) - rgwDic;
InBlock.gif
InBlock.gif 33      Zero(( int   * )psy,cwSY);
InBlock.gif
InBlock.gif 34      bltbyte(sz, psy -> sz, cch + 1 );
InBlock.gif
InBlock.gif 35       return (psy);
InBlock.gif
ExpandedBlockEnd.gif 36  }

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
使用OpenApi弹性释放和设置云服务器ECS释放
云服务器ECS的一个重要特性就是按需创建资源。您可以在业务高峰期按需弹性的自定义规则进行资源创建,在完成业务计算的时候释放资源。本篇将提供几个Tips帮助您更加容易和自动化的完成云服务器的释放和弹性设置。
7767 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,阿里云优惠总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系.
5730 0
浅谈C# 匿名变量
每次写博客,第一句话都是这样的:程序员很苦逼,除了会写程序,还得会写博客!当然,希望将来的一天,某位老板看到此博客,给你的程序员职工加点薪资吧!因为程序员的世界除了苦逼就是沉默。我眼中的程序员大多都不爱说话,默默承受着编程的巨大压力,除了技术上的交流外,他们不愿意也不擅长和别人交流,更不乐意任何人走...
800 0
戏说C语言变量
好玩的问题 今早帮老师去答疑,一位同学跑来问:“使用 printf 输出 %d、%c 时,后面传的参数都是变量的值,为什么 %s 看起来和它们不一样,要传一个地址?”我说:“小伙子很有前途,一般人不问这样的问题,哈哈!” 这个问题类似 Java 中基础类型传递值、对象传递引用,这么设计是为了提高效率。对于还没学完C语言的初学者来说,如果我给他扯一堆“底层设计”或“效率”等显然不合适,还极有
1420 0
Objective-c下变量和属性的区别
随着苹果将默认的编译器从GCC换成了LLVM,编译器自动为一个属性生成对应的变量和setter/getter方法,我们已经越来越习惯在自己创建的类中直接通过声明一个属性来创建一个类变量了。比如: #import &lt;Foundation/Foundation.h&gt; @interface Person : NSObject @property (nonatomic, st
1060 0
+关注
杨粼波
网游的老兵
1135
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
文娱运维技术
立即下载
《SaaS模式云原生数据仓库应用场景实践》
立即下载
《看见新力量:二》电子书
立即下载