VB.net 编码规范（也适用于C#）




 

 

在开发中保持良好的编码规范是十分重要的。新的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作为前缀，并用形容词命名，突出表现实现接口的类将具有什么能力：

Inte易做图ce 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.VirtualSc

补充：软件开发 , Vb ,