2.1 代码编写规范
代码规范在应用程序的开发中起着非常重要的作用,严格规范的代码能够提高代码的可读性、可维护性和可重用性。为了编写高质量的应用程序,必须从一开始就要注意养成良好的编程习惯。本节将介绍一些约定的代码编写规范。
2.1.1 标识符命名规则
为了方便代码的编写和增强代码的可读性,给代码中的对象按照一定的规则命名是非常必要的。就像每个人都有自己的名字,程序中每个变量及对象也应该命名为一个唯一的名字以便区分。下面给出具体的命名规则。
· 必须以字母或汉字开头,可由字母、汉字、数字和下画线组成。
· 不能包含Visual Basic 6.0语句的关键字。例如,不能声明一个名称为String的变量。
· 长度不能超过255个字符,控件、窗体、类和模块命名不能超过40个字符。
· 标识符不区分大小写。
对于Visual Basic 6.0中常用的一些控件,表2.1中列出了本书约定的命名方式,供读者参考。当然,读者也可以按照自己的习惯对变量进行命名。
表2.1 常用控件的命名约定
2.1.2 语句书写规范
语句的书写方式也是编写代码时要注意的,良好的语句书写格式能够让代码阅读起来更加清晰。具体的书写规则如下。
· 每条语句占一行,一行最多允许有255个字符。
· 在同一行上可以书写多句语句,但语句之间必须用冒号“:”分隔。
· 若某个语句不能在一行书写,为了不影响程序的编写和阅读。建议在本行后加入“空格”和下画线“_”组成的续行符。例如,
分行书写程序语句:
Public Declare Function GetClientRect Lib "user32" (ByVal hWnd As Long, _ lpRect As RECT) As Long
提示
在使用“空格”和下画线“_”组成的续行符时,初学者最容易犯的错误就是忘了空格。另外,在下一行书写时,尽量将代码前留出一定的空白,这样有利于代码的阅读。
2.1.3 程序注释
程序注释是对编写的代码进行解释说明。适当的程序注释能够增加程序的可读性,便于程序的编辑、调试和维护。对于初学者来说,应尽量养成对程序进行适当注释的习惯。对代码添加注释的方法如下所示。
· 对于单行注释,可以“Rem”开头或者是用单引号“'”开头引导注释内容。
· 对于整块内容的注释,可以选择编辑工具栏中的“设置注释块”和“解除注释块”命令来进行注释或解除注释,如图2.1所示。
图2.1 编辑工具栏
以下代码演示了两种注释方式。
01 '用于显示与ID对应的作者姓名 02 Rem用于显示与ID对应的作者姓名 03 Public Function ShowName(ByVal ID As Integer)
在代码的第1行采用了以“'”为开头的注释方式;代码的第2行采用了以“Rem”关键字为开头的注释方式。读者可以根据个人喜好采用不同的注释方式,这里建议用“'”开头的方式来注释。
2.1.4 格式化及缩排
代码书写中只要遵守语句书写规则就可以编写出可以运行的代码,但是为了方便程序的阅读应该采用缩进编排格式。用户可以用“Tab”键手工进行缩排,也可以通过编辑工具栏中的“缩进”和“凸出”命令进行编排。为了说明格式化及缩排的重要性,可以比较以下两段代码。
没有采用缩进的格式代码如下所示。
01 Private Sub cmdClip_Click() 02 '锁定鼠标移动范围 03 If cmdClip.Caption = "锁定鼠标移动" Then 04 ClipMouseToWindow cmdClip.hWnd 05 cmdClip.Caption = "释放鼠标" 06 Else 07 ClipCursor vbNull 08 cmdClip.Caption = "锁定鼠标移动" 09 End If 10 End Sub
采用缩进格式的代码如下所示。
01 Private Sub cmdClip_Click() 02 '锁定鼠标移动范围 03 If cmdClip.Caption = "锁定鼠标移动" Then 04 ClipMouseToWindow cmdClip.hWnd 05 cmdClip.Caption = "释放鼠标" 06 Else 07 ClipCursor vbNull 08 cmdClip.Caption = "锁定鼠标移动" 09 End If 10 End Sub
对于没有采用缩进格式的代码,只有在逐句地读完代码后,才知道代码想要干什么。而对于采用缩进格式的代码,很容易从If...Else语句结构中来划分代码段,然后判断整个代码的意图。在以后的编程过程中,也应该采用缩进结构编写代码。
提示
建议用户在编写代码时适当地在代码与代码之间留出一定的空行。例如,在变量声明语句与具体的功能执行语句之间用空行隔开,这样增加了代码的可读性,也增强了代码的美观性。就像画一幅画一样,有些地方必须“留白”,这样画才好看。