PHP开发规范

八1哥哥哦

1 PHP开发规范
1.1  命名规范

（1）文件夹命名

采用小驼峰命名法，第一个单词首字母小写，后续单词首字母大写，例：messageTemplate，图片目录为images，JS目录为js，样式表目录为css。

（2）前端命名

页面文件采用小驼峰命名法，第一个单词首字母小写，后续单词首字母大写，例：messageTemplate.html。

（3）类文件与类命名

采用大驼峰命名法，例：MessageTemplate.class。

（4）JS文件命名

采用大驼峰命名法，例：MessageTemplate.js。

1.2  代码注释

（1）文件注释

写在每个文件的开头。

/**

* 文件主要描述

* @author xxx@xxx.com

* @time 1970-01-01

*/

（2）方法功能注释

/**

* 方法主要描述

* @param string name

* @return string

*/

functionprint(name){

    ......

}

1.3  编码规范

（1）代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

（2）类名使用 UpperCamelCase 风格

   例：MarcoPolo / XmlService / TcpUdpDeal / TaPromotion

（3）方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格

    例：localValue /getHttpMessage() / inputUserId

（4）常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

    例：MAX_STOCK_COUNT /SYSTEM_EMAIL_CONFIG

（5）方法必须书写文档注释

1.4  接口规范

（1）数据格式

可以使用json格式、form-data格式、xml格式,参数禁止使用 url?name={key:value,key:value}等形式传递，正确示例：url?key=value&key=value

（2）数据返回格式

数据返回统一使用json返回，并遵循以下格式

``` json

{

    "code" : 200,

    "msg" : "返回消息内容",

    "data" : [

        {"name":"张三","sex":"男","age":18},

        {"name":"李四","sex":"女","age":19},

        {"name":"王五","sex":"男","age":20},

        {"name":"赵六","sex":"女","age":21}

    ],

    "length" : 4

}

```

code和msg必须返回，data与length按需返回，如data与length无数据，留空即可。

code: 200代表请求成功，50x代表失败或错误，严禁错误或失败时返回200，code为50x时，msg内容需详细指出错误原因。

（3）参数命名

采用下划线分割单词形式传递参数，例如：record_id / record_name