全方位分析VB.NET编码规范

开发 后端
这里介绍新的VB.NET编码规范,是一种被证明能明显改善代码可读性,并有助于代码管理、分类的编码规范。采用这种编码规范,能避免如匈牙利命名法带来的繁长前缀,便于记忆变量的用途。

学习VB.NET时,你可能会遇到VB.NET编码规范问题,这里将介绍VB.NET编码规范问题的解决方法,在这里拿出来和大家分享一下。我所采用的新的VB.NET编码规范,是一种被证明能明显改善代码可读性,并有助于代码管理、分类的编码规范。采用这种编码规范,能避免如匈牙利命名法带来的繁长前缀,便于记忆变量的用途。下面的介绍这种VB.NET编码规范。

一、类型级单位的命名

1、类。
以Class声明的类,都必须以名词或名词短语命名,体现类的作用。如:
Class Indicator
当类是一个特性(Attribute)时,以Attribute结尾,当类是一个异常(Exception)时,以Exception结尾:
Class ColorSetException
Class CauseExceptionAttribute
当类只需有一个对象实例(全局对象,比如Application等),必须以Class结尾,如
Class ScreenClass
Class SystemClass
当类只用于作为其他类的基类,根据情况,以Base结尾:
MustInherit Class IndicatorBase
如果定义的类是一个窗体,那么名字的后面必须加后缀Form,如果是Web窗体,必须加后缀Page:
Class PrintForm : Inherits Form '* Windows窗体
Class StartPage : Inherits Page '* Web窗体

2、枚举和结构
同样必须以名词或名词短语命名。***体现枚举或结构的特点,如:
Enum ColorButtons '以复数结尾,表明这是一个枚举
Structure CustomerInfoRecord '以Record结尾,表明这是一个结构体

3、委派类型
普通的委派类型以描述动作的名词命名,以体现委派类型实例的功能:
Delegate Sub DataSeeker (ByVal SeekString As String)
用于事件处理的委派类型,必须以EventHandler结尾,如:
Delegate Sub DataChangedEventHandler (ByVal Sender As Object, ByVal e As DataChangedEventArgs)

4、接口
与其他类型不同,接口必须要由I作为前缀,并用形容词命名,突出表现实现接口的类将具有什么能力:
Interface ISortable

5、模块
模块不是类型,他的名称除了必须以名词命名外,必须加以后缀Module:
Module SharedFunctionsModule
上述所有规则的共同特点是,每个组成名称的词语都必须是大写开头,禁止完全大写或小写的名称。

二、方法和属性的命名

1、方法
无论是函数还是子程序,方法都必须以动词或动词短语命名。无需区分函数和子程序,也无需指明返回类型。
Sub Open(ByVal CommandString As String)
Function SetCopyNumber(ByVal CopyNumber As Integer)
参数需要指明ByVal还是ByRef,这一点写起来会让程序边长,但非常必要。如果没有特别情况,都使用ByVal。参数的命名方法,参考后面“变量的命名方法”。需要重载的方法,一般不写Overloads,根据需要编写重载的方法。

2、属性
原则上,字段(Field)是不能公开的,要访问字段的值,一般使用属性。属性以简洁清晰的名词命名:
Property Concentration As Single
Property Customer As CustomerTypes

3、事件
事件是特殊的属性,只能在事件处理上下文中使用。命名的原则一般是动词或动词的分词,通过时态表明事件发生的时间:
Event Click As ClickEventHandler
Event ColorChanged As ColorChangedEventHangler

三、变量和常数

常数以表明常数意义的名词命名,一般不区分常数的类型:
Const DefaultConcentration As Single = 0.01
在严格要求的代码中,常数以c_开头,如c_DefaultConcentration,但***不要用它,它会带来输入困难。
普通类型的变量,只要用有意义的名字命名即可,不可使用简称和无意义的名称诸如A,x1等,下面给出了良好的例子:
Dim Index As Integer
Dim NextMonthExpenditure As Decimal
Dim CustomerName As String
不能起太长的名字,应该尽量简洁,如下面的例子:
Dim VariableUsedToStoreSystemInformation As String '* 错误,太复杂了
Dim SystemInformation As String '* 正确,简单明了
Dim sysInfo As String '* 错误,过于简单
特殊情况可以考虑一个字母的变量:
Dim g As Graphic
对于控件,应该指明控件的类型,方法是直接在变量后面加以类名:
Friend WithEvents NextPageButton As Button '* 按钮
Friend WithEvents ColorChoicerPanel As Panel '* 面版
Friend WithEvents CardFileOpenDialog As FileOpenDialog '* 文件打开对话框
等等,无需规定某种类型的变量的前缀,只需把类型写在后面就行了,试对比下列代码:
btnCancel.Text = "&Cancel"
CancelButton.Text = "&Cancel"
显然后者更能使阅读者明白变量的类型是一个按钮。

四、标签

标签就是用于Goto跳转的代码标识,由于Goto并不推荐使用,所以标签的使用也比较苛刻。标签必须全部大写,中间的空格用下划线_代替,而且应该以_开头,比如:
_A_LABEL_EXAMPLE:
如此定义标签是为了与其他代码元素充分区别。

五、名字空间

通常,一个工程使用一个名字空间,通常不需要用Namespace语句,而是在工程选项的“Root Namespace”中指定,使用根名字空间可以使代码更加整齐,容易修改,这一点是VB十足的优点。名字空间的语法是:
公司名.产品名[.组件名的复数]
如:
Namespace Ninputer.VirtualScreen
Namespace Ninputer.CardEditor.CustomeControls
随便起一个名字空间的名字绝对不是一个好主意,一定要遵守上述规定。

六、注释

注释的规则繁多,这里仅提到其中一点:正常的注释以'*开头,单独的'只用来注释暂时不用的代码
'* 这是普通的注释
'* 这段代码在调试正确后加入
'If UseHighSpeed(g) = True Then ....
这样能够方便的采用代码注释工具控制代码的使用。
以上已经简单的介绍了我使用的VB.NET编码规范,这个代码规范也适用于C#。仅供大家参考。

【编辑推荐】

  1. 简单讲述VB.NET表间拖放
  2. 五分钟学会VB.NET实现拖放
  3. 讲述强大的VB.NET Web Forms,使用起来却如此简单
  4. 分析VB QuickSort应用程序
  5. 两步就可以掌握VB使用ArrayList类
责任编辑:佚名 来源: 博客园
相关推荐

2009-10-26 13:13:17

VB.NET编码规范

2009-10-20 14:37:34

VB.NET文件操作

2011-05-19 09:20:21

VB.NETASP.NET

2010-01-11 13:42:20

VB.NET字符串加密

2009-10-27 14:32:45

VB.NET类型级命名

2009-10-27 14:49:11

VB.NET命名规范

2009-10-12 15:44:26

VB.NET动态编码技

2009-11-02 17:12:01

VB和VB.NET

2009-11-10 15:30:46

VB.NET编程原则

2009-10-28 10:04:53

VB.NET XmlW

2009-10-14 09:27:30

VB.NET编码算法

2010-01-08 17:00:22

VB.NET变量和常数

2009-10-09 17:40:38

VB.Net问题集

2009-11-02 15:57:36

VB.NET WEB

2009-10-28 14:34:44

VB.NET Tree

2010-01-15 15:39:14

VB.NET Sub过

2010-01-12 17:54:42

VB.NET Dlli

2009-11-04 09:32:12

VB.NET Auto

2009-10-13 09:24:57

VB.NET Dock

2009-10-14 15:20:21

VB.NET窗体指针
点赞
收藏

51CTO技术栈公众号