QTP框架开发命名规则与编码规范.docVIP

编码规范 脚本编写规范 变量与常量的命名规范 用下列前缀来指明一个变量的数据类型 数据类型 前缀 例子 String （字符串类型） tr strName Integer （整数类型） i intNumber Boolean（布尔类型） b b Date （日期类型） d d Object （对象类型） o objSAPSeesion Class (类对象类型) cls clsADODB Array (数组类型) arr arrScenarios Dictionary (字典类型) dic dicTestData File (文件类型) f fTestResult 变量命名规则 使用（类型前缀+单词）命名变量，单词首字母大写，含义要清晰。 错误的示范：STRNAME 正确的示范：strName 全局变量命名规则 使用（作用域+“_”+类型前缀+单词）命名变量，单词首字母大写，含义要清晰 正确的示范：g_strTestResultPath 建议将全局变量统一放在一个文件里，有利于统一管理和维护。 变量名字定义 变量名字在定义时要直接明了，选择的单词应尽量直接阐明变量含义。 比如：strActualResult 不可以是很含糊的定义。 比如：strString1, strString2 常量命名规则 常量使用由全部大写的，之间用下划线分隔_CONNECT_STRING 函数编写规范 函数命名规则 函数名在定义时单词首字母要大写，同样也要直接明了。 比如：InitialReport 在每个函数开头要有注释 在每个函数、过程或子过程中都应该有个简明的注释描述。 描述：描述函数或过程实现什么功能 依赖：列举任何外部变量、控件或其他可更改函数或过程的元素 参数：解释输入参数，每个参数最好单独一行，并且跟随注释 返回值：解释返回值 作者：说明开发或是更新的作者 时间：说明完成开发或是更新的时间 建议格式如下： ========================================================= Summary: Initial the summary reports format ‘Dependencies: frame have been set up Parameters: None Return: None Author: xiaoxijin Date: 2011-05-11 ========================================================= Function InitialReport() ‘Add some script End Function 在关键性的语句、变量前面要加有注释 ‘Please add comment 对象管理规范 对象命名规则 采用有意义的名字来标识对象，最好与页面显示字串相同 对象属性选取规则 首先disable smart identification，选取属性时尽量不使用index属性，除非万不得已或是针对某些特殊对象（如table中的单元格元素）。SAP CRM中首选html id来识别，同时需要把开始的数字字串进行正则表达式替换。 image对象：添加image type，html tag和file name属性 webedit对象：添加type，html tag和html id属性 对象库管理 尽量不要存在冗余对象，同时按照实际页面的父对象和子对象进行分门别类。