VB.NET/ASP.NET编码规范

在开发中保持良好的编码规范是十分重要的。我所采用的新的VB.NET/ASP.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"

显然后者更能使阅读者明白变量的类型是一个按钮。

四、前缀

 1、 对象

1)标准对象

名称	前缀	例子	说明
System.Array	arr	arrUsers	用户集合
System.Boolean	bln	blnDoesUserExist	用户是否存在
System.Byte	byt	bytStreamContent	字节流内容
System.Char	chr	chrKeyPress	按键
System.DateTime	dte	dteCreatedDateTime	创建日期
System.Decimal	dec	decYearlySaleQuota	年度销售额
System.Double	dbl	dblTotalPrice	总金额
System.Interger	int	intMessages	消息数
System.Object	obj	objExternalFunction	外部功能
System.Single	sng	sngFinishRate	完成率
System.String	str	strLoginName	登陆名称
System.Exception	exc	excRet	错误
System.Enum	enm	enmUserStates	用户状态
Structure	stu	stuEmployees	员工类型
System.Data.SqlClient.SqlConnection	cnn	cnnDatabase	数据库连接
System.Data.SqlClient.SqlCommand	cmm	cmmUserAddUpdate	用户添加更新
System.Data.SqlClient.SqlDataAdapter	sda	sdaUsers	用户数据适配器
System.Data.SqlClient.SqlDataReader	sdr	sdrUserData	用户数据读取器

 2)自定义对象

                  我们规定应该根据自定义对象的名称来确定该对象类型的前缀，例子如下:

                  对象：SysSet

                  前缀：ss

                  例子：ssSafety

         2、根据变量与常量的生存周期，我们应该定义不同的生存周期前缀以示区别，以便我们清楚该变量/常量的范围。

a)      类、模块、组件、控件

我们规定在类、模块、组件、控件范围内，变量的生存周期前缀应该添加“m_”(Module－模块)。例子如下：

名称	前缀	例子	说明
System.Array	m_arr	m_arrUsers	用户集合
System.Boolean	m_bln	m_blnDoesUserExist	用户是否存在
System.Byte	m_byt	m_bytStreamContent	字节流内容
System.Char	m_chr	m_chrKeyPress	按键
System.DateTime	m_dte	m_dteCreatedDateTime	创建日期
System.Decimal	m_dec	m_decYearlySaleQuota	年度销售额
System.Double	m_dbl	m_dblTotalPrice	总金额
System.Interger	m_int	m_intMessages	消息数
System.Object	m_obj	m_objExternalFunction	外部功能
System.Single	m_sng	m_sngFinishRate	完成率
System.String	m_str	m_strLoginName	登陆名称
System.Exception	m_exc	m_excRet	错误
System.Enum	m_enm	m_enmUserStates	用户状态
Structure	m_stu	m_stuEmployees	员工类型
System.Data.SqlClient.SqlConnection	m_cnn	m_cnnDatabase	数据库连接
System.Data.SqlClient.SqlCommand	m_cmm	m_cmmUserAddUpdate	用户添加更新
System.Data.SqlClient.SqlDataAdapter	m_sda	m_sdaUsers	用户数据适配器
System.Data.SqlClient.SqlDataReader	m_sdr	m_sdrUserData	用户数据读取器

过程、函数、属性、事件我们规定在过程、函数、属性、事件范围内，变量的生存周期前缀应该添加“o_”(Owner－私有)。例子如下：

名称前缀

 例子 说明 

System.Array o_arr

 o_arrUsers

 用户集合

 System.Boolean

 o_bln

 o_blnDoesUserExist

 用户是否存在

System.Byte

 o_byt

 o_bytStreamContent

 字节流内容

 System.Char

 o_chr

 o_chrKeyPress

 按键

 System.DateTime

 o_dte

 o_dteCreatedDateTime

 创建日期

 System.Decimal

 o_dec

 o_decYearlySaleQuota

 年度销售额

 System.Double

 o_dbl

 o_dblTotalPrice

 总金额

 System.Interger

 o_int

 o_intMessages

 消息数

System.Object

 o_obj

 o_objExternalFunction

 外部功能

 System.Single

 o_sng

 o_sngFinishRate

 完成率

System.String

 o_str

 o_strLoginName

 登陆名称

System.Exception

 o_exc

 o_excRet

 错误

System.Enum

 o_enm

 o_enmUserStates

 用户状态

Structure

 o_stu

 o_stuEmployees

 员工类型

System.Data.SqlClient.SqlConnection

 o_cnn

 o_cnnDatabase

 数据库连接

System.Data.SqlClient.SqlCommand

 o_cmm

 o_cmmUserAddUpdate

 用户添加更新

System.Data.SqlClient.SqlDataAdapter

 o_sda

 o_sdaUsers

 用户数据适配器

System.Data.SqlClient.SqlDataReader

 o_sdr

 o_sdrUserData

 用户数据读取器 

五、标签

标签就是用于Goto跳转的代码标识，由于Goto并不推荐使用，所以标签的使用也比较苛刻。标签必须全部大写，中间的空格用下划线_代替，而且应该以_开头，比如：

_A_LABEL_EXAMPLE:

如此定义标签是为了与其他代码元素充分区别。

六、名字空间

通常，一个工程使用一个名字空间，通常不需要用Namespace语句，而是在工程选项的“Root Namespace”中指定，使用根名字空间可以使代码更加整齐，容易修改，这一点是VB十足的优点。名字空间的语法是：

公司名.产品名[.组件名的复数]

如：

Namespace COM.NET
Namespace COM.File.IO.Files

随便起一个名字空间的名字绝对不是一个好主意，一定要遵守上述规定。 

七、格式化

    良好的格式化代码对我们的浏览与维护有相当的好处。

1、 块

.NET提供了#Region...#End Region块控制。我们应该根据代码所实现的功能分类并以块组织起来。

2、 缩进

每个层次直接都应该以Tab进行缩进，而不是Space(空格键)。 

3、 流

每个方法、函数、属性、事件应该有且只有一个入口和一个出口。如果遇见多层嵌套而需要直接跳出的时候，请使用局部Boolean或者Integer变量来标示用以多层跳出。

        譬如：

        Private Function TestForReturn () As Boolean

            Dim o_blnRet As Boolean=False

            Dim i As Integer, l As Integer

            For i=1 To 100

                For l=1 To 10

                    If (x) Then

                        o_blnRet=True

                        Exit For

                    Else

                    End If

                Next

                If o_blnRet Then

                    Exit For

                Else

                End If

            Next

            Return o_blnRet ''这里是唯一出口

        End Function

 八、注释

1、 准则

注释的规则繁多，基本地：正常的注释以''*开头，单独的''只用来注释暂时不用的代码

''* 这是普通的注释
''* 这段代码在调试正确后加入
''If UseHighSpeed(i) = True Then ....

这样能够方便的采用代码注释工具控制代码的使用。

 

2、类（包括WebForm、WinForm等）、模块、组件、控件

   每个类、模块、组件、控件最开始的地方必须输入该对象的信息，样例内容与格式如下：

''******************************************************************

''*

''*  对象名称：OnlineUpdateService

''*  命名空间： http://www.domain.cn/onlineupdate/OnlineUpdateService.asmx

''*  作    者：chs(Wilson Chan)

''*  功能说明：在线更新Web Services

''*  创建日期：2003/07/27

''*  修改日期：2003/09/5 16:59

''*  修改记录：

''*            □2003/07/31

''*              1.AddUpdateUserCategory/DeleteUserCategory

''*              2.AddUpdateUserState/DeleteUserState

''*              3.AddUpdateServerUpdate/DeleteServerUpdate

''*              4.AddUpdateClientUpdate/DeleteClientUpdate

''*              5.AddUpdateClientUpdateLog/DeleteClientUpdateLog

''*              6.GetServerUpdates/GetClientUpdates/GetClientUpdateLogs

''*

''******************************************************************

一般地，我们要求内容有：对象名称、命名空间、作者、功能说明、创建日期、修改日期、修改记录，特别地，我们要求修改记录应该详细叙述最近的修改。

 

3、方法、函数、事件与属性

每个方法、函数、事件与属性最开始的地方必须输入该对象的信息，样例内容与格式如下：

  ''*****************************************************************

 

  ''*名称：OnlineUpdateFileAddUpdate

  ''*功能：添加更改更新信息

   ''*作者：chs

   ''*创建：2003/7/31

   ''*修改：2003/7/31

   ''*参数：intID：唯一标示

   ''*      strTitle：标题

   ''*      strVersion：版本

   ''*      strVerifier：标示

   ''*     strDescription：描述

   ''*      strRelatedFile：相关文件

   ''*      strUpdatePackage：下载包

   ''*      intState：状态

   ''*      dteCreatedDateTime：创建日期

   ''*返回：成功，True，反之，False

   ''*说明：

  ''******************************************************************

一般地，我们要求内容有：名称、功能、作者、说明、创建、修改、参数与返回。

 八、完整性

    1、If...Else...End If

    2、Select Case...Case Else...End Select 

九、安全性

    1、Try...Catch...Finally...End Try

十、优化

    1、With

    2、For...Next

    3、Do Until...Loop

    4、代码重构 

 十一、其它