VB.net 编码规范.docVIP

文档状态： 文档编号： 规范_VB.net编码 [ ] Draft [√] Released [ ] Modifing 编 撰： 王英杰 编撰日期： 2006-5-21 保密级别： 机密 文档版本： 2.0.0 VB.net?编码规范 铁道科学研究院电子计算技术研究所 北京经纬信息技术公司 版 本 历 史 日期 版本 说明 作者 2006-04-08 0.0.1 初稿 王英杰 2006-04-30 1.0.0 咨询公司审计通过，正式发布 EPG 2006-05-21 2.0.0 增加系统集成项目过程 佘振国 目 录 1 目的 4 2 范围 4 3 规范内容 4 3.1 类型级单位的命名 4 3.2 方法和属性的命名 5 3.3 变量和常数 5 3.4 标签 6 3.5 名字空间 6 3.6 注释 6 VB.net?编码规范 目的 为了保证所每个项目组编写出的程序都符合相同的规范保证一致性、统一性VB.net程序编码规范。 范围 该规范适用于所有基于VB.Net开发的项目。 规范内容 3.1 类型级单位的命名 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 上述所有规则的共同特点是，每个组成名称的词语都必须是大写开头，禁止完全大写或小写的名称。 3.2 方法和属性的命名 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 3.3 变量和常数 常数以表明常数意义的名词命名，一般不区分常数的类型：Const Defa