使用匈亚利命名法

C#

浏览数:53

2019-8-30

1.在Form编程中使用匈亚利命名法

匈牙利命名法:小写开头,首单词为数据类型,举例:intCount、iCount。通常不推荐在编程中使用,被认为是过时的命名方法,因为IDE的智能提示很容易让你知道变量的类型。

然而,在WinForm、ASP.NET WebForm编程中,我喜欢使用匈亚利命名法给窗体中的控件命名。我把窗体中的控件简单分为“操控型”和“编辑型”。

1.1 “操控型”控件命名

“操控型”控件主要指菜单、按钮、树图等触发点击事件的控件。命名举例:menuFile、menuFile_Open分别表示一个一级和二级菜单,btnFile_Open表示一个按钮,这也避免了无前缀时菜单和按钮功能相同时命名重复的尴尬。另外,如果你在IDE中输入一个menu,所有的菜单控件会按字母顺序在智能提示栏中整齐的排列显示。IDE为按钮menuFile自动生成的点击事件函数命名为private void menuFile_Click(),这比File_Click()更好理解,因为在这里智能提示不能告诉你File是什么东东。

1.2 “编辑型”控件命名

在添加或编辑数据的界面中,会有大量的“编辑型”控件。“编辑型”控件指文本框、下拉框、复选框、单选框等需要用户输入数据的控件,注意选择也是一种输入,这些控件通常与数据实体的属性一一对应。这时我们可以考虑使用统一的前缀edit给这些控件命名,如编辑框editName对应实体对象的Name属性。使用统一的前缀edit,为的就是在IDE中输入前缀后,其智能提示的内容与实体对象的属性提示保持顺序上的一致,不被其它控件的名字插入而干扰对应的一致性。

这里,我们较多的考虑了IDE(特别是智能提示)对编程的影响。同时我们也看到微软IDE生成的事件函数名字并没完全遵守微软不使用下划线的约定。命名规范不是一成不变的,在特定场景下可以有自己风格的约定,前提是要使代码保持一致、易读。

2.对匈牙利命名法的误解

其实,我们一直对匈牙利命名法存有误解。匈牙利命名法的发明人是微软公司的Simonyi,他来自匈牙利。在Simonyi的匈牙利命名法中,每个变量的开头是一个小写字母的标签,表明变量中包含什么种类的数据,注意是“种类”—kind,而不是“类型”—type。因为Simonyi在他的原始文档中错误地使用了type这个词,导致好几代程序员都误解了他的意思。

2.1 应用型匈牙利命名法

Simonyi的匈牙利命名法在微软内部叫“应用型匈牙利命名法”,因为它是在“应用程序部”(这个部门)中使用的,即用在Word和Excel源代码上。如在Excel源代码中,rw和col(前缀)会大量存在,但通常都是整数。“应用型匈牙利命名法”中前缀是非常有含义的,在未提供类型识别的早期编译工具中,其作用是巨大的。

2.2 系统型匈牙利命名法

相对的,另一种以数据类型为前缀的匈牙利命名法被称为“系统型匈牙利命名法”,如l代表long、i代表int、dw代表double word等,它的好处实在微小,但因为以讹传讹,它被大量传用,现在我们严重不推荐在编程中使用这种命名法。

3.小结

“应用型匈牙利命名法”仍然极具价值,它使用有意义的“种类”前缀,使代码更易阅读、书写和维护。我们在Form编程中使用匈亚利命名法,实际上是在Form控件的命名中加了“种类”前缀,而不是僵硬的“数据类型”。

参考文献

《软件随想录》(卷2)[美]Joel Spolsky.

(备注:本文为本人以前在微信公众号中发布的文章,重新在简书发布一下,欢迎交流)

作者:夏春涛