欢迎访问西安鸥鹏IT教育中心 !西安最专业的思科、华为认证培训中心。

029-88235527
当前位置:首页 > 新闻资讯 > 公司动态

自动化测试脚本编码规范

时间:2017年07月09日 10:36:11     来源:未知 作者:鸥鹏
自动化测试脚本编码规范

介绍

1.为什么需要编码规范?
编码规范对于程序员而言,尤为重要,有以下几个原因:
一个软件的生命周期中,80%的花费在于维护;
几乎没有任何一个软件,在其整个生命周期中,均由最初的开发来维护;
编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码;
如果你将源码作为产品发布,就需要确认它是否被很好的打包并且清晰无误,一如你已构建的其他任何产品;

命名

1.包命名
包名规则:一个唯一的包名的前缀总是全部小写的ASCII字母并且是一个顶级域名,如com、edu、gov、net、org等。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范需要以特定目录名的组成来区分部门,项目,模块等。
例如:com.bestpay.cif.core.manager --------重生项目的某一个包,在没有特别要求的情况下,尽量按这种格式命名包名。
自动化测试用例不需要新建包名,与开发的包公用一个。
2.类和接口的命名
命名规则:每个单词首字母大写,尽量简洁而富于描述。使用完整单词,避免缩写(除非缩写已被广泛使用)。
例如: 
Activity  ------  [xxx]Activity.java   eg:SplashActivity
Dialog   ------  [xxx]Dialog.java      eg:LoginDialog
Service ------- [xxx]Service.java       
常用的工具类--[xxx]Util.java
自动化测试的类命名一般在开发的类后面加Test即可,如开发的类名是Activity,测试的类名应为ActivityTest。
3.方法的命名
命名规则:第一个单词首字母小写,其后单词的首字母大写,以包含测试场景为佳,如下两个示例:
testOrderIsFilledIfEnoughInWarehouse()
testOrderDoesNotRemoveIfNotEnough()
注:桩方法应该在方法后面中加上stub关键字。
4.变量命名
命名规则:第一个单词首字母小写,其后单词首字母大写。尽量避免单个字符的变量名。 
5.常量命名
命名规则:类常量的声明,应该全部大写,单词间用下划线隔开。
例如:static final int MIN_WIDTH = 4 ;
      static final int MAX_WIDTH = 999;
6.异常命名
命名规则:自定义异常的命名必须以Exception为结尾,用以明确表示为一个异常。

注释

Java程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。
实现注释使用/*...*/ 和 // 。
文档注释使用/**...*/,文档注释可以通过javadoc工具转换生成HTML文件
 
1.文件注释
所有源文件都应该在开头有一个注释,其中列出类名、版本信息、日期和版权声明。
/*
* 文件名 
* 包含类名列表
* 版本信息,版本号
* 创建日期。
* 版权声明
*/
2.类注释
每一个类都应该包含如下格式的注释,以说明当前类的功能等
/**
*  类名
*  @author 作者 <br/>
* 实现的主要功能。
* 创建日期
* 修改者,修改日期,修改内容。
*/
3. 方法注释
每一个方法都应该包含如下格式的注释,包括当前方法的用途,当前方法参数的含义,当前方法的返回值的内容和抛出异常的列表。
/**
*
*  方法的一句话概述
*  <p>方法详述(简单方法可不必详述)</p>
*  @params 说明参数含义
*  @return 说明返回值含义
*  @throws IOException 说明发生此异常的条件
*  @throws NullPointerException 说明发生此异常的条件
*/
4.类成员变量和常量注释
成员变量和常量要使用java doc形式的注释说明当前变量或常量的含义。
/**
*  XXXX含义
*/
5.其他注释
方法内部的注释如果需要多行使用/*…*/形式,如果单行使用//…形式注释。方法内部不要使用java doc注释。

相关文章

  • 地址:陕西省西安市雁塔区融鑫路3号自力集团院内2楼
    咨询电话:029-88235527 88211379
    面授课程:思科网络培训 红帽系统培训 甲骨文数据库培训 JAVA软件培训 Android软件培训 企业项目培训 软件测试培训 虚拟化培训
  • 了解鸥鹏动态
    关注鸥鹏教育服务号

  • 扫码关注西安鸥鹏
    身边的移动开发导师