开发者文档

一、约束

---

1. 开发规范原则上按照ThinkPHP5.0完全开发手册中的标准。
2. 模块 common 中 web 目录内的 BaseModel 为基础共用的 model，不写入任何其他模块业务相关方法。
3. 在模块 common 中的模型中显式定义数据库名称。
4. 模块 web 中，是我们编写具体业务的模块。其中 model 目录先继承 common 中 model 目录下的 model 再写自己的逻辑。
5. 模块 web 中，控制器需要继承当前模块的 Controller，该 Controller 需要继承 common 模块中的 WebController。
6. 公共方法参考 common.php，该文件不要维护，如需添加内容，请与项目负责人联系。
7. 异常处理使用 application\common\exception\BaseException。
8. 返回数据必须使用$this->throwError、$this->renderJson、$this->renderSuccess、$this->renderError。参考 application\common\service\Render。
9. 不允许直接使用 Db 操作数据库（特殊需要请说明原因）。
10. 原则上在 Controller 不做数据库操作。
11. 所有类编写注释。 ~~~ /** * 类说明 * * Class 类名称 * @package 位置（例如：app\sapi\controller） */ ~~~
12. 任何方法都需要编写注释，说明参数已经方法的含义。 ~~~ /** * 方法说明 * * @param 参数名 含义 * @return 返回类型（例如：array|bool|mixed） * @throws 异常处理（例如：\think\exception\DbException） */ ~~~
13. 任何变量、常量、对象等都需注释说明含义。 ~~~ // 含义 或 /* @var 类型 名称 含义 / ~~~ 14.原则上每行代码都需要注释清楚作用，也可同一功能一起加注释，如果逻辑性较强的区域需要注释开始、结束。 ~~~ /---------- 说明 start ----------/ /---------- 说明 end ----------*/ ~~~ ### 二、关于权限 ---