快速业务通道

VBScript教程 第十课 VBScript编码约定

作者 佚名 来源 ASP编程 浏览 发布时间 2013-07-09
hsbVolume
图像                img           imgIcon
标签                lbl           lblHelpMessage
直线                lin           linVertical
列表框               lst           lstPolicyCodes
旋钮                spn           spnPages
文本框               txt           txtLastName
垂直滚动条             vsb           vsbRate
滑块                sld           sldScale

代码注释约定

所有过程的开始部分都应有描述其功能的简要注释。这些注释并不描述细节信息(如何实现功能),这是因为细节有时要频繁更改。这样就可以避免不必要的注释维护工作以及错误的注释。细节信息由代码本身及必要的内部注释来描述。

当传递给过程的参数的用途不明显,或过程对参数的取值范围有要求时,应加以说明。如果过程改变了函数和变量的返回值(特别是通过参数引用来改变),也应在过程的开始部分描述该返回值。

过程开始部分的注释应包含以下区段标题。相关样例,请参阅后面的"格式化代码"部分。

区段标题 注释内容
目的   过程的功能(不是实现功能的方法)。
假设   其状态影响此过程的外部变量、控件或其他元素的列表。
效果   过程对每个外部变量、控件或其他元素的影响效果的列表。
输入   每个目的不明显的参数的解释。每个参数都应占据单独一行并有其内部注释。
返回   返回值的解释。

请记住以下几点:

·每个重要的变量声明都应有内部注释,描述变量的用途。
·应清楚地命名变量、控件和过程,仅在说明复杂细节时需要内部注释。
·应在 Script 的开始部分包含描述该 Script 的概述,列举对象、过程、运算法则、对话框和其他系统从属物。有时一段描述运算法则的假码是很有用的。

格式化代码

应尽可能多地保留屏幕空间,但仍允许用代码格式反映逻辑结构和嵌套。以下为几点提示:

·标准嵌套块应缩进 4 个空格。
·过程的概述注释应缩进 1 个空格。
·概述注释后的最高层语句应缩进 4 个空格,每一层嵌套块再缩进 4 个空格。例如:

''*********************************************************
'' 目的: 返回指定用户在 UserList 数组中第一次出现的位置。
'' 输入: strUserList(): 所查找的用户列表。
'' strTargetUser: 要查找的用户名。
'' 返回: strTargetUser 在 strUserList 数组中第一次出现时的索引。
'' 如果目标用户未找到,返回 -1。
''*********************************************************

Function intFindUser (strUserList(), strTargetUser)
Dim i '' 循环计数器。
Dim blnFound '' 发现目标的标记。
intFindUser = -1
i = 0 '' 初始化循环计数器。
Do While i <= Ubound(strUserList) and Not blnFound
If strUserList(i) = strTargetUser Then
blnFound = True '' 标记设为 True。
intFindUser = i '' 返回值设为循环计数器。
End If
i = i + 1 '' 循环计数器加 1。
Loop
End Function


凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务,公司网站:http://www.lingzhong.cn 为了给广大客户了解更多的技术信息,本技术文章收集来源于网络,凌众科技尊重文章作者的版权,如果有涉及你的版权有必要删除你的文章,请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息,谢谢!

分享到: 更多

Copyright ©1999-2011 厦门凌众科技有限公司 厦门优通互联科技开发有限公司 All rights reserved

地址(ADD):厦门软件园二期望海路63号701E(东南融通旁) 邮编(ZIP):361008

电话:0592-5908028 传真:0592-5908039 咨询信箱:web@lingzhong.cn 咨询OICQ:173723134

《中华人民共和国增值电信业务经营许可证》闽B2-20100024  ICP备案:闽ICP备05037997号