mirror of
https://gitee.com/ShopeX/ECShopX
synced 2026-08-10 13:26:05 +08:00
删除文件 docs/docs/ad1v2f.md
This commit is contained in:
@@ -1,37 +0,0 @@
|
||||
---
|
||||
url: ad1v2f
|
||||
---
|
||||
|
||||
# API控制器规范
|
||||
|
||||
<a name="70ea3b94"></a>
|
||||
## 资源控制器
|
||||
|
||||
<br />**必须** 优先使用 [Restful 资源控制器](http://learnku.com/docs/laravel/5.5/controllers#restful-resource-controllers) 。<br />
|
||||
|
||||
<a name="972987d4"></a>
|
||||
## 单数 or 复数?
|
||||
|
||||
<br />**必须** 使用资源的复数形式,如:<br />
|
||||
|
||||
> - 类名:PhotosController
|
||||
> - 文件名:PhotosController.php
|
||||
|
||||
|
||||
<br />错误的例子:<br />
|
||||
|
||||
> - 类名:PhotoController
|
||||
> - 文件名:PhotoController.php
|
||||
|
||||
|
||||
|
||||
<a name="c98bd870"></a>
|
||||
## 保持短小精炼
|
||||
|
||||
<br />**必须** 保持控制器文件代码行数最小化,还有可读性。<br />
|
||||
|
||||
- **不应该** 为「方法」书写注释,这要求方法取名要足够合理,不需要过多注释;
|
||||
- **应该** 为一些复杂的逻辑代码块书写注释,主要介绍产品逻辑 - `为什么要这么做。`;
|
||||
- **不应该** 在控制器中书写「私有方法」,控制器里 `应该` 只存放「路由动作方法」;
|
||||
- **绝不** 遗留「死方法」,就是没有用到的方法,控制器里的所有方法,都应该被使用到,否则应该删除;
|
||||
- **绝不** 在控制器里批量注释掉代码,无用的逻辑代码就必须清除掉。
|
||||
Reference in New Issue
Block a user