自动化测试脚本编码规范

为什么需要编码规范?

编码规范对于程序员而言,尤为重要,有以下几个原因:

一个软件的生命周期中,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程序有两类注释:实现注释(implementationcomments)和文档注释(document comments)。

实现注释使用/*...*/ 和 // 。

文档注释使用/**...*/,文档注释可以通过javadoc工具转换生成HTML文件

1.文件注释

所有源文件都应该在开头有一个注释,其中列出类名、版本信息、日期和版权声明。

/*

* 文件名

* 包含类名列表

* 版本信息,版本号

* 创建日期。

* 版权声明

*/

2.类注释

每一个类都应该包含如下格式的注释,以说明当前类的功能等

/**

* 类名

* @author作者 <br/>

* 实现的主要功能。

* 创建日期

* 修改者,修改日期,修改内容。

*/

3. 方法注释

每一个方法都应该包含如下格式的注释,包括当前方法的用途,当前方法参数的含义,当前方法的返回值的内容和抛出异常的列表。

/**

*

* 方法的一句话概述

* <p>方法详述(简单方法可不必详述)</p>

@params 说明参数含义

@return说明返回值含义

@throws IOException 说明发生此异常的条件

@throws NullPointerException 说明发生此异常的条件

*/

4.类成员变量和常量注释

成员变量和常量要使用javadoc形式的注释说明当前变量或常量的含义。

/**

* XXXX含义

*/

5.其他注释

方法内部的注释如果需要多行使用/*…*/形式,如果单行使用//…形式注释。方法内部不要使用java doc注释。

最后: 为了回馈铁杆粉丝们,我给大家整理了完整的软件测试视频学习教程,朋友们如果需要可以自行免费领取 【保证100%免费】

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

代码小怡

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值