必須 優(yōu)先使用 Restful 資源控制器 。
必須 使用資源的復數(shù)形式,如:
- 類名:PhotosController
- 文件名:PhotosController.php
錯誤的例子:
- 類名:PhotoController
- 文件名:PhotoController.php
必須 保持控制器文件代碼行數(shù)最小化,還有可讀性。一般來講,一個方法不應該超過 20 行代碼,業(yè)務邏輯比較多,請封裝到一個 Service 類里。
不應該 為「方法」書寫 很明顯的注釋,這要求方法取名要足夠合理,不需要過多注釋。
應該 為一些復雜的邏輯代碼塊書寫注釋,主要介紹產(chǎn)品邏輯 - 為什么要這么做。
,最重要的,寫好上下文。
不應該 在控制器中書寫「私有方法」,控制器里 應該
只存放「路由動作方法」。
多余的業(yè)務邏輯,請封裝到 Service 類中。
絕不 遺留「死方法」,就是沒有用到的方法,控制器里的所有方法,都應該被使用到,否則應該刪除。
絕不 在控制器里批量注釋掉代碼,無用的邏輯代碼就必須清除掉。
項目中會使用 Git 來做版本控制,刪了后面也可以從記錄中找到,無需將這些無用的代碼留在項目中。
更多建議: