# 代码规范 **状态码分类** ~~~ 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(列表) ~~~ **代码注释规范** ~~~ /** * 测试方法 * * @ApiTitle (方法名test) * @ApiSummary (测试描述信息) * @ApiAuthor (接口作者) * @ApiMethod (POST) * @ApiRoute (/api/demo/test/) * @ApiHeaders (name=token, type=string, required=true, description="请求的Token") * @ApiParams (name="id", type="integer", required=true, description="会员ID") * @ApiParams (name="name", type="string", required=true, description="用户名") * @ApiParams (name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}", description="扩展数据") * @ApiReturnParams (name="code", type="integer", required=true, sample="0") * @ApiReturnParams (name="msg", type="string", required=true, sample="返回成功") * @ApiReturnParams (name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}", description="扩展数据返回") * @ApiReturn ({ 'code':'1', 'msg':'返回成功' }) */ public function test() { $this->success('返回成功', $this->request->param()); } ~~~ | 标签 | 实例 | 说明 | | --- | --- | --- | | @abstract | | 抽象类的变 和方法 | | @access | public, private or protected | 文档的访问和使用权限。＠ ccess private表明这个文档是私有的 | | @author | 小明 | 文档作者信息 | | @copyright | 名称时间 | 文档版权信息 | | @deprecated | Version | 文档中被废除的方法 | | @deprec | | 同 @deprecated | | @example | /path/to/example | 文挡的外部保存示例文件的位置 | | @exception | | 文档中方法抛出的异常，也可参照＠ hrows | | @global | 类型 $globalvarname | 文档中的全局变量及有关的方法和函数 | | @ignore | | 忽略文档中指定的关键字 | | @internal | | 开发团队内部信息 | | @link | URL | 类似于lic se ，但还可以通过访问 地址找到文档中更多的详细信息 | | @name | 变量别名 | 为某个变量指定别名 | | @magic | | PHPDoc兼容phpDocumentor的标签 | | @package | 封装包的名称 | 一组相关类、函数封装的包名称 | | @param | usemame 用户名 | 输入变量含义注释 | | @return | 如返回bool | 输出函数返回结果描述，一般不用在vo id 空返回结果的〕的函数中 | | @see | Class Login() | 文件关联的任何元素（全局变量，包括页面、类、函数、定义、方法、变量〉 | | @since | version | 记录什么时候对文档的哪些部分进行了更改 | | @static | | 记录静态类、方法 | | @staticvar | | 在类、函数中使用的静态变量 | | @subpackage | | 子版本 | | @throws | | 抛出的异常 | | @todo | | 表示文件未完成或者要完善的地方 |