编码约定是帮助您使用 Microsoft Visual Basic Scripting Edition 编写代码
些建议
编码约定包含以下内容: ·对象、变量和过程
命名约定 ·注释约定
·文本格式和缩进指南
使用
致编码约定主要原因是使 Script 或 Script 集结构和编码样式标准化
这样代码易于阅读和理解使用好编码约定可以使源代码明白、易读、准确更加直观且和其他语言约定保持致 常数命名约定
VBScript
早期版本不允许创建用户自定义常数如果要使用常数则常数以变量方式实现且全部字母大写以和其他变量区分常数名中多个单词用下划线 (_) 分隔例如: USER_LIST_MAX
NEW_LINE
这种标识常数
思路方法依旧可行但您还可以选择其他方案用 Const 语句创建真正常数这个约定使用大小写混合
格式并以“con”作为常数名前缀例如: conYourOwnConstant
变量命名约定
出于易读和
致性目请在 VBScript 代码中使用以下变量命名约定: 子类型 前缀 举例
Boolean bln blnFound
Byte byt bytRasterData
Date (Time) dtm dtmStart
Double dbl dblTolerance
Error err errOrderNum
Integer
Quantity Long lng lngDistance
Object obj objCurrent
Single sng sngAverage
String str strFirstName
变量作用域
变量应定义在尽量小
作用域中VBScript 变量作用域如下所示: 作用域 声明变量处 可见性
过程级 事件、
或子过程 在声明变量过程中可见 Script 级 HTML 页面
HEAD 部分任何过程的外 在 Script 所有过程中可见 变量作用域前缀
随着 Script 代码长度
增加有必要快速区分变量作用域在类型前缀前面添加个单
前缀可以实现这点而不致使变量名过长 作用域 前缀 举例
过程级 无 dblVelocity
Script 级 s sblnCalcInProgress
描述性变量名和过程名
变量名或过程名
主体应使用大小写混合格式并且尽量完整地描述其目另外过程名应以动词开始例如 InitNameArray 或 CloseDialog 对于经常使用
或较长名称推荐使用标准缩写以使名称保持在适当长度内通常多于 32 个变量名会变得难以阅读使用缩写时应确保在整个 Script 中保持致例如在个 Script 或 Script 集中随意切换 Cnt 和 Count 将造成混乱 对象命名约定
下表列出了 VBScript 中可能用到
对象命名约定(推荐): 对象类型 前缀 举例
3D 面板 pnl pnlGroup
动画按钮 ani aniMailBox
复选框 chk chkReadOnly
组合框、下拉列表框 cbo cboEnglish
命令按钮
cmd cmdExit
公共对话框 dlg dlgFileOpen
框架 fra fraLanguage
水平滚动条 hsb hsbVolume
图像 img imgIcon
标签 lbl lblHelpMessage
直线 lin linVertical
列表框 lst lstPolicyCodes
旋钮 spn spnPages
文本框 txt txtLastName
垂直滚动条 vsb vsbRate
滑块 sld sldScale
代码注释约定
所有过程
开始部分都应有描述其功能简要注释这些注释并不描述细节信息(如何实现功能)这是
细节有时要频繁更改这样就可以避免不必要注释维护工作以及
注释细节信息由代码本身及必要内部注释来描述 当传递给过程
参数用途不明显或过程对参数取值范围有要求时应加以介绍说明如果过程改变了和变量返回值(特别是通过参数引用来改变)也应在过程开始部分描述该返回值 过程开始部分
注释应包含以下区段标题相关样例请参阅后面“格式化代码”部分 区段标题 注释内容 目
过程功能(不是实现功能思路方法) 假设 其状态影响此过程外部变量、Control控件或其他元素列表 效果 过程对每个外部变量、Control控件或其他元素影响效果列表 输入 每个目不明显参数解释每个参数都应占据单独行并有其内部注释 返回 返回值解释 请记住以下几点:
·每个重要
变量声明都应有内部注释描述变量用途 ·应清楚地命名变量、Control控件和过程
仅在介绍说明复杂细节时需要内部注释 ·应在 Script
开始部分包含描述该 Script 概述列举对象、过程、运算法则、对话框和其他系统从属物有时段描述运算法则假码是很有用 格式化代码
应尽可能多地保留屏空间
但仍允许用代码格式反映逻辑结构和嵌套以下为几点提示: ·标准嵌套块应缩进 4 个空格
·过程
概述注释应缩进 1 个空格 ·概述注释后
最高层语句应缩进 4 个空格每层嵌套块再缩进 4 个空格例如: \'*********************************************************
\' 目
: 返回指定用户在 UserList 
中第次出现位置\' 输入: strUserList
: 所查找用户列表\' strTargetUser: 要查找
用户名\' 返回: strTargetUser 在 strUserList
中第次出现时索引\' 如果目标用户未找到
返回 -1\'*********************************************************
Function
FindUser (strUserList, strTargetUser)Dim i \' 循环计数器
Dim blnFound \' 发现目标
标记FindUser = -1i = 0 \'
化循环计数器Do While i <= Ubound(strUserList) and Not blnFound
If strUserList(i) = strTargetUser Then
blnFound = True \' 标记设为 True
FindUser = i \' 返回值设为循环计数器End If
i = i + 1 \' 循环计数器加 1
Loop
End Function
最新评论