规范是很重要的,如果我们编码没有了规范我们的程序就会很乱,在开发中保持良好的编码规范是十分重要的。我所采用的新的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、VB.NET类型级命名接口
与其他类型不同,接口必须要由I作为前缀,并用形容词命名,突出表现实现接口的类将具有什么能力:
- Interface ISortable
5、VB.NET类型级命名模块
模块不是类型,他的名称除了必须以名词命名外,必须加以后缀Module:
- Module SharedFunctionsModule
上述所有规则的共同特点是,每个组成名称的词语都必须是大写开头,禁止完全大写或小写的名称。
【编辑推荐】