VB代码编写规范

Eddy 发布于2011-4-20 13:19:5 分类: 程序设计 已浏览loading 网友评论0条 我要评论

VB代码编写规则
代码编写规则是养成良好编程习惯的基础。下面主要介绍VB代码编写规则,包括对象命名规则、代码书写规则、处理关键字冲突和代码注释规则。

一、对象命名规则
当为对象、属性、方法及事件命名时,应选择易于被用户理解的名字。名字含义越清晰,则代码的可用性越强。

这里的对象命名规则适用于:

l 对象。

l 组成对象接口的属性、方法及事件。

l 属性、方法及事件的命名的参数。

具体命名规则如下。

(1)尽可能使用完整的单词或音节

对用户来说,记住整个的单词比记住缩略词更容易,例如Window被缩略为Wind、Wn或Wnd,不如Window本身好记。下面通过两个例子说明推荐使用的对象名称,如表1所示。

表1 推荐使用的对象名称


不要用

不要用

Application
App
SpellCheck
SpChk
 

如果标识符太长而需要缩略时,则尽量用完整的首音节。例如,用AltExpEval,而不用AlternateExpressionEvaluation或AltExpnEvln。

(2)大小写混用

所有标识符都应混用大小写,而不是用下划线来分割其中的单词。下面通过两个例子说明推荐使用的对象命名称,如表2所示。

表2 推荐使用的对象名称


不要用

ShortcutMenus
Shortcut_Menus, Shortcutmenus, SHORTCUTMENUS, SHORTCUT_MENUS

BasedOn
basedOn
 

(3)使用一致的术语

使用与接口相同的单词;不要用诸如HWND之类的基于匈牙利命名法的标识符命名。记住,这些代码是要被其他用户访问的,因此尽量使用用户描述一个概念时可能会采用的单词。

(4)集合类名使用正确的复数

对集合采用复数而不用新的名称可以减少用户必须记忆项的数目。这样也简化了对集合的命名。表3列出了集合类名称的一些例子。

表3 推荐使用的对象名称


不要用

不要用

Axes
Axiss
SeriesCollection
CollectionSeries

Windows
ColWindow


 

例如,如果有一名为Axis的类,则Axis对象的集合存储在Axes类中。同样,Vertex对象的集合存储在Vertices类中。极少情况下当单数和复数的拼写一样时,则在其后面添加一个“Collection”,例如,SeriesCollection。

注意:此命名约定可能不适用于某些集合,尤其在一组对象存在于多个集合时。例如,Mail程序可能有一个Name对象存在于多个集合中:ToList、CcList等等。在这种情况下,可以将这些独立的name集合命名为ToNames和CcNames。

(5)常数使用前缀

选择三、四个小写字母组成标识部件的前缀,把它用在部件类型库中部件提供的常数名上,以及定义那些常数的Enums名上。

例如,提供贷款评估的代码可以使用levs作为前缀。下面贷款的枚举类型Enum使用了该前缀。(此外,这些常数包含大写字母LT,以标识它们所属的枚举。)

Public Enum LoanType

levsLTMortgage = 1

levsLTCommercial

levsLTConsumer

End Enum

(6)动词/对象和对象/动词

如果创建的方法名是一个动词及其作用的对象名的组合,则次序必须保持一致。或者在所有情况下都将动词放在对象前面,如InsertWidget和InsertSprocket,或者总是将对象放在前面,如WidgetInsert和SprocketInsert。

两种方法各有所长。动词/对象次序创建的名称更象日常说话,因而能更好的表示此方法的意图。而对象/动词的次序则便于将影响某一特定对象的所有方法集合到一起。

二、代码书写规则
1.可将单行语句分成多行

可以在“代码”窗口中用续行符“ _”(一个空格后面跟一个下划线)将长语句分成多行。由于使用续行符,无论在计算机上还是打印出来的代码都变得易读。例如声明一个API函数,代码如下:

'声明API函数用于异步打开一个文档

Private Declare Function ShellExecute Lib "shell32.dll" Alias "ShellExecuteA" _

(ByVal hwnd As Long, ByVal lpOperation As String, ByVal lpFile As String, _

ByVal lpParameters As String, ByVal lpDirectory As String, ByVal nShowCmd As Long) As Long

注意:在同一行内,续行符后面不能加注释。

2.可将多个语句合并写到同一行上

通常,一行之中有一个Visual Basic语句,而且不用语句终结符。但是也可以将两个或多个语句放在同一行,只是要用冒号“:”将它们分开。例如给数组连续赋值,其代码如下:

a(0) = 11: a(1) = 12: a(3) = 13: a(4) = 14: a(5) = 15: a(6) = 16

3.可在代码中添加注释

以Rem或“’”(半个引号)开头,VB就会忽略该符号后面的内容。这些内容就是代码段中的注释,既方便开发者也为以后可能检查源代码的其他程序员提供方便。例如为下面的代码添加注释:

Dim a As String '定义一个字符型变量

Dim a As String Rem 定义一个字符型变量

注意:如果在语句行后使用Rem关键字,则必须在语句后使用冒号“:”与Rem关键字隔开,而且Rem关键字与注释文字间要有一个空格。

4.在输入代码时不区分大小写。

5.一行最多允许输入255个字符。

三、处理关键字冲突
在代码的编写中为避免Visual Basic中元素(Sub和Function过程、变量、常数等等)的名字与关键字发生冲突,它们不能与受到限制的关键字同名。

受到限制的关键字是在Visual Basic中使用的词,是编程语言的一部分。其中包括预定义语句(比如If和Loop)、函数(比如Len和Abs)和操作符(比如Or和Mod)。

窗体或控件可以与受到限制的关键字同名。例如,可以将某个控件命名为If。但在代码中不能用通常的方法引用该控件,因为在Visual Basic中If意味着关键字。例如,下面这样的代码就会出错。

If.Caption = “同意” '出错

为了引用那些与受到限制的关键字同名的窗体或控件,就必须限定它们,或者将其用方[ ]括号括起来。例如,下面的代码就不会出错。

MyForm. If.Caption = “同意” '用窗体名将其限定

[If].Caption = “同意” '方括号起了作用

四、代码注释规则
注释是一种非执行语句,它不仅仅是对程序的解释说明,同时还对程序的调用起着非常重要的作用,如利用注释来屏蔽一条语句,当程序再次运行时,可以发现问题或错误。这样大大提高了编程速度,减少了不必要的代码重复。代码注释规则如下:

(1)程序功能模块部分要有代码注释,简洁明了阐述该模块的实现功能。

(2)程序或模块开头部分要有以下注释:模块名、创建人、日期、功能描述等。

(3)在给代码添加注释时,尽量使用中文。

(4)用注释来提示错误信息,以及出错原因。

下面介绍几种注释的方法。

1.利用代码或语句添加注释
在Visual Basic中使用的“'”符号或“Rem”关键字,可以为代码添加注释信息,“'”符号可以忽略掉后面的一行内容,这些内容是代码段中的注释。这些注释主要为了以后查看代码时,帮助用户快速理解该代码的内容。注释可以和语句在同一行出现,并写在语句的后面,也可独自占据一整行。

(1)注释占据一行,在需要解释的代码前。

'为窗体标题栏设置文字

Me.caption="明日科技"

Rem 在文本框中放欢迎词

Text1.Text = "欢迎您使用本软件!!!"

(2)注释和语句在同一行并写在语句的后面。

Me.caption="明日科技" '为窗体标题栏设置文字

Text1.Text = "欢迎您使用本软件!!!": Rem 在文本框中放欢迎词

(3)注释占据多行,通常用来说明函数、过程等的功能信息。通常在说明前后使用注释和“=”、“*”符号强调。例如下面的代码:

'==========================================================

'名称:CalculateSquareRoot

'功能:求平方根

'日期:2008-03-02

'单位:mingrisoft

'==========================================================

Function CalculateSquareRoot(NumberArg As Double) As Double

If NumberArg < 0 Then '评估参数

Exit Function '退出调用过程

Else

CalculateSquareRoot = Sqr(NumberArg) '返回平方根。

End If

End Function

2.利用工具栏按钮为代码添加注释
为了方便对大段程序进行注释,可以通过选中两行或多行代码,并在“编辑”工具栏上通过选择“设置注释块”按钮 或“解除注释块”按钮 来对大段代码块添加或解除注释“'”符号。设置或取消连续多行的代码注释块的步骤如下:

(1)在工具栏上单击鼠标右键,在弹出的对话框中,选择“编辑”命令,将其“编辑”工具栏添加到窗体工具栏中。

(2)选中要设置注释的代码,然后单击“编辑”工具栏中的“设置注释块”工具栏按钮,如下图所示。也可以将光标放置需要注释代码所在行,单击“设置注释块”按钮即可。


例如,使用注释块注释代码,选中需要注释的代码,单击“设置注释块”工具栏按钮,即可将选中的代码全部注释,注释后的效果如下。

'Private Sub Command1_Click()

' Command2.Enabled = True

' Command1.Enabled = False

'End Sub

“解除注释块”工具栏按钮与“注释块”工具栏按钮功能正好相反,主要用于清除选中代码前的“'”符号,从而解除该代码块的注释。

注意:在使用注释符号“'”时,不能将注释符号“'”接在“_”续行符之后。


 

已经有(0)位网友发表了评论,你也评一评吧!
原创文章如转载,请注明:转载自Eddy Blog
原文地址:http://www.rrgod.com/program/763.html     欢迎订阅Eddy Blog

记住我的信息,下次不用再输入 欢迎给Eddy Blog留言