VB.net 编码规范

原创 2006年06月05日 14:58:00

http://stonecn.cnblogs.com/archive/2006/06/05/417630.html

本文在前人的基础上修改,原来是一份从网上下载的VB.Net编码规范,我以自己的方式做了小部分的改动,并根据自己的习惯添加了一些内容。

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

  一、类型级单位的命名

  1、类。

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

  

        Class Indicator 


  当类是一个特性(Attribute)时,以Attribute结尾,当类是一个异常(Exception)时,以Exception结尾:
  
        Class ColorSetException 

        Class CauseExceptionAttribute 


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

  Class ScreenClass 

  
Class SystemClass 

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

  MustInherit Class IndicatorBaseClass 

  如果定义的类是一个窗体,那么名字的后面必须加后缀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 ObjectByVal 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" 

  显然后者更能使阅读者明白变量的类型是一个按钮。(以前我都是使用前缀的形式,后来发现前缀缩写难记且不容易理解,还是使用后缀的形式更为有效)

  四、标签

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

  _A_LABEL_EXAMPLE: 


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

  五、名字空间

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

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

  如: 

  Namespace Ninputer.VirtualScreen 

  
Namespace Ninputer.CardEditor.CustomeControls


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

  六、注释

  注释的规则繁多,这里仅提到其中一点:正常的注释以'*开头,单独的'只用来注释暂时不用的代码

  '* 这是普通的注释 

  
'* 这段代码在调试正确后加入 

  
'If UseHighSpeed(g) = True Then 



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

 

相关文章推荐

vb.net 教程 4-7 文本文件编码 2

本节将用一个简单的例子来说明文本编码: 窗体设计如下: comboBox中的数据: 请引用 System.Text Imports System.Text 当按下“生成”按钮时的代码: ...

VB.NET导出excel并支持中文文件名 中文编码

Public Partial Class Doc_List_Excel    Inherits System.Web.UI.Page#Region "变量宣告区"    'Dim Ap_Code As...
  • wybshyy
  • wybshyy
  • 2016年07月29日 14:07
  • 352

vb.net 教程 4-7 文本文件编码 1

通常情况下,文件可以分为文本文件和二进制文件。 文本文件就是可以直接用记事本打开看到内容的文件,比如后缀为txt、htm、log等等。 其余的文件就是二进制文件,比如.exe、.dll、.mp3等等。...

Wince5.0下实现XP风格的开始菜单源码(VB.net编码实现)

如果想学自定义控件及自己写事件和绑定事件处理过程,请仔细阅读源码,此源码属100%原创,遵循GPL协议但不限于GPL,本人给予复制创新者以用于商业软件的权力,但复制创新者对于本源码实现功能的提升修改必...
  • angxiao
  • angxiao
  • 2012年03月18日 00:06
  • 821

VB.NET代码规范

VB.NET代码规范   1 编程风格 1.1 统一编程风格的意义 · 增加开发过程代码的强壮性、可读性、易维护性 · 减少有经验和无经验开发人员编程所需的脑力工作 · 为软件的良好...

VB net 编码规范

  • 2009年01月02日 15:28
  • 37KB
  • 下载

C++, .NET 编码规范

  • 2013年03月28日 13:10
  • 445KB
  • 下载

C#.NET编码规范整理

C#.NET编码规范整理一、  环境设置 首先去除VS开发环境中的一些选项如下:粘贴时调整缩进将类型的左大括号置于新行将方法的左大括号置于新行将匿名方法的左大括号置于新行将控制块的左大括号置于新行将“...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:VB.net 编码规范
举报原因:
原因补充:

(最多只允许输入30个字)