appium+python 【Mac】UI自动化测试封装框架介绍 <七>---脚本编写规范

脚本的使用，注释非常关键，无论自己的后期查看还是别人使用，都可以通过注释很明确的知道代码所表达的意思，明确的知道如何调用方法等等。每个团队均有不同的商定形式来写脚本，因此没有明确的要求和规范来约束。
如下将介绍我们的测试脚本编写规范主要集中的几个方面：

1、方法的命名
2、脚本的注释
3、方法的解释与调用注意事项
 #---接口层：脚本解释命名规范如下

　　def test(self,element):
    '''
　　  :method explain:
            - 此方法的解释
    　:ndertake method:
            - 此方法的执行需要承接的前提条件的方法
    　:Args:
            -参数介绍：如： element - 要查找的元素
   　 :Usage:
            - 使用此方法示例
    ''' 
    
#---目录结构文件夹命名规范

　　模块之间的命名规则应一致，模块中的测试用例命名规则也需一致,示例如下：

　　--Call
　　　　--Case_Call_01_CallPhone
　　　　--Case_Call_02_DeletedRecord
　　--Message
　　　　--Case_Message_01_EditMessage
　　　　--Case_Message_02_SendMessage

#---参数名称命名规则

　　变量名应该简单，尽量的使用缩写，如果是一般的值类型，则直接用变量名用途命名，尽量使用全名称，例如：name，phoneNumber，如果是一般的临时性变量定义，应该尽可能的简单，例如：int i等，如果
名称由多个单词组成，则取每个单词的首字母等。

#--方法名命名

　　方法名称若较长时，则需在单词之间使用下划线，并且第二个单词的首字母可大写，若方法名称不能很好地解释此方法想要表达的含义时，可再此方法名称下加入注释。

#--代码注释规范

　　注释务必做到准确简洁，能够充分表达代码实现的功能与注意点

#--脚本执行流程

　　有必要的情况下，请务必输出流程图，并对每个流程中的关键点进行说明。

#--版本控制

　　多人协作时，脚本一般会使用SVN或者是Git进行管理，此时要求每个人员在进行上传修改的脚本更新时，备注需要写的明确，主要修改了哪个文件、此文件中的哪个方法进行了修改，修改的原因是什么等。