VB.NET/ASP.NET编码规范

北大青鸟大学城校区logo 北大青鸟大学城校区
招生简章校园环境师资力量就业明星招生问答软件工程师北京大学学历学员项目联系我们 报名通道

免费在线咨询通道>>

免费在线报名通道>>

北大青鸟报名电话
当前位置:北大青鸟 > 软件教程 > .net教程 >

VB.NET/ASP.NET编码规范

标签:   分类:.net教程


VB.net/ASP.NET编码规范 http://www.mscto.com

在开发中保持良好的编码规范是十分重要的。我所采用的新的VB.net/ASP.NET编码规范,是一种被证明能明显改善代码可读性,并有助于代码管理、分类的编码规范。采用这种编码规范,能避免如匈牙利命名法带来的繁长前缀,便于记忆变量的用途。下面的介绍这种编码规范。


一、类型级单位的命名

1、类

□以Class声明的类,都必须以名词或名词短语命名,体现类的作用。如: 软件开发

ClassIndicator
□当类是一个特性(Attribute)时,以Attribute结尾,当类是一个异常(Exception)时,以Exception结尾: 软件开发网

ClassColorSetException

ClassCauseExceptionAttribute
□当类只需有一个对象实例(全局对象,比如Application等),必须以Class结尾,如

ClassScreenClass

ClassSystemClass
□当类只用于作为其他类的基类,根据情况,以Base结尾:

MustInheritClassIndicatorBase
□如果定义的类是一个窗体,那么名字的后面必须加后缀Form,如果是Web窗体,必须加后缀Page: http://www.mscto.com

ClassPrintForm:InheritsForm''*Windows窗体

ClassStartPage:InheritsPage''*Web窗体

2、枚举和结构

同样必须以名词或名词短语命名。最好体现枚举或结构的特点,如:

软件开发网

EnumColorButtons''以复数结尾,表明这是一个枚举

StructureCustomerInfoRecord''以Record结尾,表明这是一个结构体

软件开发网


3、委派类型

□普通的委派类型以描述动作的名词命名,以体现委派类型实例的功能: 软件开发网

DelegateSubDataSeeker(ByValSeekStringAsString)
□用于事件处理的委派类型,必须以EventHandler结尾,如:

http://www.mscto.com

DelegateSubDataChangedEventHandler(ByValSenderAsObject,ByValeAsDataChangedEventArgs)


4、接口

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

InterfaceISortable


5、模块 http://www.mscto.com

模块不是类型,他的名称除了必须以名词命名外,必须加以后缀Module:

软件开发网

ModuleSharedFunctionsModule 软件开发网

上述所有规则的共同特点是,每个组成名称的词语都必须是大写开头,禁止完全大写或小写的名称。


二、方法和属性的命名 软件开发网

1、方法

无论是函数还是子程序,方法都必须以动词或动词短语命名。无需区分函数和子程序,也无需指明返回类型。

SubOpen(ByValCommandStringAsString)
FunctionSetCopyNumber(ByValCopyNumberAsInteger)

参数需要指明ByVal还是ByRef,这一点写起来会让程序边长,但非常必要。如果没有特别情况,都使用ByVal。参数的命名方法,参考后面“变量的命名方法”。需要重载的方法,一般不写Overloads,根据需要编写重载的方法。

若有疑问请拨打北大青鸟咨询热线:010-80146691或点击免费在线咨询!
  • xml地图 网站地图 招生简章 合作企业 学员项目 联系我们
  • 关闭窗口