个人觉得你所描述的只是自动化脚本中应该填写的部分注释
开展自动化脚本开发，不一定有什么特别的格式。规定这些格式和注释只是为了小组成员可以很好的在一个平台上共同协作，开发自动化脚本。
那么要写的内容要包括更多的规定，才能很好的开展自动化脚本的开发。
下面的规定你可以考虑应用到你们的测试项目中：
对象、变量和过程的命名约定
1、常数命名约定
常数名中的多个单词用下划线 (_) 分隔。
例如： USER_LIST_MAX NEW_LINE
这种标识常数的方法依旧可行，但您还可以选择其他方案，用 Const 语句创建真正的常
数。这个约定使用大小写混合的格式，并以"con"作为常数名的前缀。例如： conYourO
wnConstant
2、变量命名约定
通常遵守匈牙利命名法
根据实际情况可以调整
类型 前缀 例子
Boolean bln blnFound
Byte byt bytRasterData
Date (Time) dtm dtmStart
Double dbl dblTolerance
Error err errOrderNum
Integer int intQuantity
Long lng lngDistance
Object obj objCurrent
Single sng sngAverage
对于改变量名的规范可以适当那么严格
变量作用域
变量应定义在尽量小的作用域中。VBScript 变量的作用域如下所示：
作用域 声明变量处 可见性
过程级 事件、函数或子过程 在声明变量的过程中可见
Script 级 HTML 页面的 HEAD 部分，任何过程之外 在脚本的所有过程中可见
随着脚本代码长度的增加，有必要快速区分变量的作用域。在类型前缀前面添加一个单
字符前缀可以实现这一点，而不致使变量名过长。
描述性变量名和过程名
匈牙利命名法的核心
变量名或过程名的主体应使用大小写混合格式，并且尽量完整地描述其目的。另外，过
程名应以动词开始，例如 InitNameArray 或 CloseDialog。 对于经常使用的或较长的
名称，推荐使用标准缩写以使名称保持在适当的长度内。通常多于 32 个字符的变量名
会变得难以阅读。使用缩写时，应确保在整个脚本中保持一致。例如，在一个脚本或脚
本集中随意切换 Cnt 和 Count 将造成混乱。
2.1.5对象命名约定
下表列出了 VBScript 中可能用到的对象命名约定（推荐）：
对象命名约定
对象类型 前缀 示例
3D 面板 pnl pnlGroup
动画按钮 ani aniMailBox
复选框 chk chkReadOnly
组合框、下拉列表框 cbo cboEnglish
命令按钮 cmd cmdExit
公共对话框 dlg dlgFileOpen
框架 fra fraLanguage
水平滚动条 hsb hsbVolume
图像 img imgIcon
数据集 rs rs1
文件对象 fso fso1
2．1．6、代码注释约定 文本格式和缩进指南
所有过程的开始部分都应有描述其功能的简要注释。
这些注释并不描述细节信息（如何实现功能），这是因为细节有时要频繁更改。这样就
可以避免不必要的注释维护工作以及错误的注释。细节信息由代码本身及必要的内部注
释来描述。 当传递给过程的参数的用途不明显，或过程对参数的取值范围有要求时，应
加以说明。如果过程改变了函数和变量的返回值（特别是通过参数引用来改变），也应
在过程的开始部分描述该返回值。
1、代码注释约定
每个重要的变量声明都应有内部注释，描述变量的用途。
应清楚地命名变量、控件和过程，仅在说明复杂细节时需要内部注释。
应在脚本的开始部分包含描述该脚本的概述，列举对象、过程、运算法则、对话框和其
他系统从属物。有时一段描述运算法则的注释是很有用的。
2、文本格式和缩进指南
应尽可能多地保留屏幕空间，但仍允许用代码格式反映逻辑结构和嵌套。以下为几点提
示：
A、标准嵌套块应缩进 4 个空格。
B、过程的概述注释应缩进 1 个空格。
C 、概述注释后的最高层语句应缩进 4 个空格，每一层嵌套块再缩进 4 个空格。
3、注释文本格式和缩进例子
'************************************************
' 作者： 该程序有 某某 书写
' 目的： 返回指定用户在 UserList 数组中第一次出现的位
置。
' 输入： strListUser (): 所查找的用户列表。
' 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
