自动化脚本编码规范

《自动化脚本编码规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Alimama开发测试组文档目录AlimamaSDTPHP编码规范2作者2前言：2一、PHP命名规则21.1变量命名21.2常量命名21.3函数命名21.4目录文件命名2二、PHP脚本文件的构成及注释32.1功能说明部分32.2包含声明部分：32.3具体的业务逻辑32.4自定义函数部分：42.5类的注释方式5三、PHP书写格式约定：5四、MMT测试脚本约定64.1测试脚本的构成：64.2目录结构举例：64.3说明：64.4技巧：7五、XHTML代码规范75.1样式表的引用75.2缩进、换行约定75.3书写规范85.4表单变量命名约定9六、JavaScript代码规范9

2、6.1变量命名约定96.2函数命名、注释约定96.3代码书写规范10七、Subverion操作约定：10第10页共10页Alimama开发测试组文档AlimamaSDTPHP编码规范作者王春生邮箱chunsheng.wang@alibaba-inc.comwwccss@263.net历史创建于2006-08-1110:22，最后修改于2008-07-0816:29前言：l本规范的目的是让保证team成员编码的统一。l本规范的核心规则就是驼峰方式的命名规则。l此规范必要时可以打破。一、PHP命名规则1.1变量命名l采用驼峰方式。首字母小写，后面的字母按照大小写间隔的方式

3、加以区分，比如userName,serviceIDl如果有单词缩写，则采用大写形式。如：PID。l应该避免大写的单词在一起，因为无法直接判断单词的分割，比如IMGFile，应该写成imgFile。l类名，类的属性命名规则与此相同。l数据库、表、字段的命名规则与此相同。lSQL查询语句中关键词使用大写。 比如：SELECT*FROMuserListWHERE1.2常量命名l采用大写单词与下划线间隔的方式，比如IMATCH_DISPATCHER_API。1.3函数命名l采用驼峰方式，动词加名词，动词小写，后面的名词用大小写间隔。比如：getAdInfo()l如果需要，可以

4、增加小写的前缀，这时动词则大写开始。比如：imGetAdInfo()l类的方法命名规则与此相同，不过类的方法一般不需要增加前缀了。1.4目录文件命名l目录和文件一般采用小写的格式，尽量使用两个以内的单词表达。第10页共10页Alimama开发测试组文档l不建议使用下划线间隔的方式。但如果目录或者文件名过长，无法使用少量单词表达时，应当使用下划线。l不建议使用大写字母，但如果要表达的名称是大家约定俗称的，应尊重旧有的习惯。二、PHP脚本文件的构成及注释l每个文件按照以下顺序排列：功能说明部分、包含声明部分、具体的业务逻辑、自定义函数部分。l注释按照phpdoc的标准进行

5、，这样可以和c++程序统一起来。http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.pkg.html2.1功能说明部分在每一个文件的开头部分，要包含这个程序的简要说明、详细说明以及作者和最后修改时间。注释采用phpdoc的注释方式。

6、com,wwccss@263.net>*@version$Id$*/?>说明：l详细说明部分是可选的，如果某个文件的逻辑比较复杂，可以在详细说明部分加以解释。l其中的$Id$会被自动替换成subverion的相应信息，其中包含文件名、日期、修改者等信息。2.2包含声明部分：在每个文档的开头部分包含此程序所用到的包含文件。如：include'init.php';include'func/common.php';2.3具体的业务逻辑l注释的原则是将问题解释清楚，并不是越多越好。l若干语句作为一个逻辑代码块，这个块的注释可以使用/**/方式。l具体到某一个语句的注释，可以使

7、用行尾注释：//或者#，但应当保持风格一致。第10页共10页Alimama开发测试组文档/*生成配置文件、数据文件。*/$this->setConfig();$this->createConfigFile();$this->clearCache();#清除缓存文件。$this->createDataFiles();//生成数据文件。$this->prepareProxys();$this->restart();2.4自定义函数部分：l如果当前PHP脚本需要定义一个函数，则在文件尾部声明。l凡有两个以上文件用到的函数，应将其定义在一个公共的函数库文件中