### 目录和文件 * 目录使用小写+下划线；. * 类库、函数文件统一以`.php`为后缀； * 类的文件名均以命名空间定义，并且命名空间的路径和类库文件所在路径一致； * 类文件采用驼峰法命名（首字母大写），其它文件采用小写+下划线命名； * **类名和类文件名保持一致**，统一采用驼峰法命名（首字母大写）； ### 函数和类、属性命名 * 类的命名采用驼峰法（首字母大写），例如`User`、`UserType`，默认不需要添加后缀，例如`UserController`应该直接命名为`User`； * 函数的命名使用小写字母和下划线（小写字母开头）的方式，例如`get_client_ip`； * 控制器内方法命名使用小写字母和下划线（小写字母开头）的方式，例如`get_client_ip`； * 方法的命名使用驼峰法（首字母小写），例如`getUserName`； * 属性的命名使用驼峰法（首字母小写），例如`tableName`、`instance`； * 特例：以双下划线`__`打头的函数或方法作为魔术方法，例如`__call`和`__autoload`； 函数和方法的区别：*函数*是单独存在的,也就是面向过程部分定义的;而*方法*是依赖于类存在的,也就是面向对象中定义的 ### 常量和配置 * 常量以大写字母和下划线命名，例如`APP_PATH`； * 配置参数以小写字母和下划线命名，例如`url_route_on`和`url_convert`； * 环境变量定义使用大写字母和下划线命名，例如`APP_DEBUG`； ### 数据表和字段 * 数据表和字段采用小写加下划线方式命名，并注意字段名不要以下划线开头，例如`think_user`表和`user_name`字段，不建议使用驼峰和中文作为数据表及字段命名。 ### 系统编码 UTF-8 LF **请理解并尽量遵循以上命名规范，可以减少在开发过程中出现不必要的错误。** # 代码规范 **状态码分类** ~~~ HTTP状态码分类 分类 分类描述 1** 信息，服务器收到请求，需要请求者继续执行操作 2** 成功，操作被成功接收并处理 3** 重定向，需要进一步的操作以完成请求 4** 客户端错误，请求包含语法错误或无法完成请求 5** 服务器错误，服务器在处理请求的过程中发生了错误 200 成功 10001 输入参数错误 10002 网络错误 10003 文件错误，请检查是否responseheader是否缺少Content-Length 10004 格式错误 10005 系统错误 401 500 403 302 -1 未知错误 ~~~ **代码规范** ~~~ 1．提高代码复用即， 个代码片段出现过多次，就可以考虑封装其为公共方法； 3. 接口除了域名外，路径写全，方便前端对接 4. 自定义类库统一放在根目录下的extend下面, composer类库放在vendor下面、自定义的函数放在common.php里面 5. 在引用模型或者其他类库的方法时，注释一下时干嘛的 ~~~ **类库引用规范** ~~~ 1. 自定义类库统一放在根目录下的extend下面, composer类库放在vendor下面、自定义的函数放在common.php里面 2. 在引用模型或者其他类库的方法时，注释一下时干嘛的 ~~~ **接口返回规范** ~~~ 1.{"code"="1","msg"="返回信息"，"data"="数据"，"time"="数据请求时间" } 2.code=1是成功，失败的自定义 ~~~ **命名规范** ~~~ 1. 采用驼峰法命名，同样的方法，命名为 getUserNarne()比命名为 getusernarne()更易于阅读、采用_命名或者首字母大写 2. 命名方式必须在整个项目中统一 3. 方法的作用都是执行一个动作，达到一个目的。所以名称应该说明方法是做什么的。一般名称的前缀都是有第一规律的，如is（判断）、get（得到），set（设置），del(删除)，add(添加)，edit(修改)，show(展示)，details(详情)、lists(列表) ~~~