自动化脚本编码规范.docxVIP

目录 TOC \o 1-5 \h \z \o Current Document Alimama SDT PHP 编码规范 2 作者 2 前言： 2 一、 PHP命名规贝IJ 2 \o Current Document 1.1变量命名 2 \o Current Document 「2常量命名 2 \o Current Document 1.3函数命名 2 \o Current Document 1.4目录文件命名 2 \o Current Document 二、 PHP脚本文件的构成及注释 3 \o Current Document 2.1功能说明部分 3 \o Current Document 2.2包含声明部分： 3 \o Current Document 2?3具体的业务逻辑 3 \o Current Document 2.4自定义函数部分： 4 \o Current Document 25类的注释方式 5 \o Current Document 三、 PHP书写格式约定： 5 \o Current Document 四、 MMT测试脚本约定 6 \o Current Document 4?1测试脚本的构成： 6 \o Current Document 4.2目录结构举例： 6 \o Current Document 4.3说明： 6 \o Current Document 4.4技巧： 7 \o Current Document 五、 XHTML代码规范 7 \o Current Document 5?1样式表的引用 7 \o Current Document 5.2缩进、换行约定 7 \o Current Document 5.3书写规范 8 \o Current Document 5.4表单变量命名约定 9 \o Current Document 六、 JavaScript代码规范 9 \o Current Document 6.1变量命名约定 9 \o Current Document 6.2函数命名、注释约定 9 \o Current Document 6.3彳弋码书写规范 10 \o Current Document 七、 Subverion 操作约定： 10 Alimama SDT PHP 编码规范 作者 王春生 邮箱 chunsheng.wang@ wwccss@263?net 1历史 创建于 2006-08-11 10:22,最后修改于 2018-01-05 12:58 | 刖S : 本规范的0的是让保证team成员编码的统一。 本规范的核心规则就是驼峰方式的命名规则。 此规范必要时可以打破。 PHP命名规贝！］ 1.1变量命名 采用驼峰方式。首字母小写，后面的字母按照大小写间隔的方式加以区分，比如userName, servicelD 如果有单词缩写，则采用大写形式。如：PID o 应该避免大写的单词在一起，因为无法直接判断单词的分割，比如IMGFile,应该写成imgFileo 类名，类的属性命名规则与此相同。 数据库、表、字段的命名规则与此相同。 SQL查询语句屮关键词使用大写。 比如：SELECT * FROM userList WHERE 1.2常量命名 采用人写单词与下划线间隔的方式,比如IMATCH_DI SPATCHER_AP I。 1.3函数命名 采用驼峰方式，动词加名词，动词小写，后面的名词用大小写间隔。比如：getAdlnfo () 如果需要，可以增加小写的前缀，这时动词则大写开始。比如：imGe匕Ad：Lnfo() 类的方法命名规则与此相同，不过类的方法一般不需要增加前缀了。 1.4目录文件命名 ? 冃录和文件一般采用小写的格式，尽量使用两个以内的单词表达。 不建议使用下划线间隔的方式。但如果目录或者文件名过长，无法使用少量单词表达时，应当使用下划线。 不建议使用大写字母，但如果要表达的名称是大家约定俗称的，应尊重旧有的习惯。 :、PHP脚本文件的构成及注释 每个文件按照以下顺序排列：功能说明部分、包含声明部分、具体的业务逻辑、自定义函数部分。 注释按照phpdoc的标准进行，这样可以和C++程序统一起来。 http : //manual .phpdou ? org/HTMLSmairtyConverter/HandS/phpDouumerrtor/tutorial—phpDouum entor ? pkg ? html 2.1功能说明部分 在每一个文件的开头部分，要包含这个程序的简要说明、详细说明以及作者和最后修改时间。注释采用phpdoc的注 释方式。 ?