经过长时间学习VB.NET,于是和大家分享一下关于VB.NET命名规范,看完本文你肯定有不少收获,希望本文能教会你更多东西。
VB.NET命名规范方法和属性
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
VB.NET命名规范变量和常量:
常数以表明常数意义的名词命名,一般不区分常数的类型:
- 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"
显然后者更能使阅读者明白变量的类型是一个按钮。
【编辑推荐】