From 1c0bdab9f940b34e5c177e8ac51a9b2926e61ce7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=94=90=E6=B0=B8=E5=B7=9D?= Date: Fri, 26 Jun 2026 13:34:15 +0000 Subject: [PATCH] =?UTF-8?q?=E5=88=A0=E9=99=A4=E6=96=87=E4=BB=B6=20docs/doc?= =?UTF-8?q?s/ad1v2f.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/docs/ad1v2f.md | 37 ------------------------------------- 1 file changed, 37 deletions(-) delete mode 100644 docs/docs/ad1v2f.md diff --git a/docs/docs/ad1v2f.md b/docs/docs/ad1v2f.md deleted file mode 100644 index 15a4b30..0000000 --- a/docs/docs/ad1v2f.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -url: ad1v2f ---- - -# API控制器规范 - - -## 资源控制器 - -
**必须** 优先使用 [Restful 资源控制器](http://learnku.com/docs/laravel/5.5/controllers#restful-resource-controllers) 。
- - -## 单数 or 复数? - -
**必须** 使用资源的复数形式,如:
- -> - 类名:PhotosController -> - 文件名:PhotosController.php - - -
错误的例子:
- -> - 类名:PhotoController -> - 文件名:PhotoController.php - - - - -## 保持短小精炼 - -
**必须** 保持控制器文件代码行数最小化,还有可读性。
- -- **不应该** 为「方法」书写注释,这要求方法取名要足够合理,不需要过多注释; -- **应该** 为一些复杂的逻辑代码块书写注释,主要介绍产品逻辑 - `为什么要这么做。`; -- **不应该** 在控制器中书写「私有方法」,控制器里 `应该` 只存放「路由动作方法」; -- **绝不** 遗留「死方法」,就是没有用到的方法,控制器里的所有方法,都应该被使用到,否则应该删除; -- **绝不** 在控制器里批量注释掉代码,无用的逻辑代码就必须清除掉。