thinkphp 命名規範
阿新 • • 發佈:2020-12-07
目錄和檔案
- 目錄使用小寫+下劃線;
- 類庫、函式檔案統一以
.php
為字尾; - 類的檔名均以名稱空間定義,並且名稱空間的路徑和類庫檔案所在路徑一致;
- 類檔案採用駝峰法命名(首字母大寫),其它檔案採用小寫+下劃線命名;
- 類名和類檔名保持一致,統一採用駝峰法命名(首字母大寫);
函式和類、屬性命名
- 類的命名採用駝峰法(首字母大寫),例如
User
、UserType
,預設不需要新增字尾,例如UserController
應該直接命名為User
; - 函式的命名使用小寫字母和下劃線(小寫字母開頭)的方式,例如
get_client_ip
; - 方法的命名使用駝峰法(首字母小寫),例如
getUserName
; - 屬性的命名使用駝峰法(首字母小寫),例如
tableName
instance
; - 以雙下劃線“__”打頭的函式或方法作為魔術方法,例如
__call
和__autoload
;
常量和配置
- 常量以大寫字母和下劃線命名,例如
APP_PATH
和THINK_PATH
; - 配置引數以小寫字母和下劃線命名,例如
url_route_on
和url_convert
;
資料表和欄位
- 資料表和欄位採用小寫加下劃線方式命名,並注意欄位名不要以下劃線開頭,例如
think_user
表和user_name
欄位,不建議使用駝峰和中文作為資料表字段命名。
應用類庫名稱空間規範
應用類庫的根名稱空間統一為app(不建議更改,可以設定app_namespace
配置引數更改,V5.0.8
版本開始使用APP_NAMESPACE