crmeb
遵循PSR-2
命名規(guī)范和PSR-4
自動加載規(guī)范,并且注意如下規(guī)范:
目錄和文件
- 目錄使用小寫+下劃線;
- 類庫、函數(shù)文件統(tǒng)一以
.php
為后綴; - 類的文件名均以命名空間定義,并且命名空間的路徑和類庫文件所在路徑一致;
- 類文件采用駝峰法命名(首字母大寫),其它文件采用小寫+下劃線命名;
- 類名和類文件名保持一致,統(tǒng)一采用駝峰法命名(首字母大寫);
函數(shù)和類、屬性命名
- 類的命名采用駝峰法(首字母大寫),例如
User
、UserType
,默認(rèn)不需要添加后綴,例如UserController
應(yīng)該直接命名為User
; - 函數(shù)的命名使用小寫字母和下劃線(小寫字母開頭)的方式,例如
get_client_ip
; - 控制器內(nèi)方法命名使用小寫字母和下劃線(小寫字母開頭)的方式,例如
get_client_ip
; - 方法的命名使用駝峰法(首字母小寫),例如
getUserName
; - 屬性的命名使用駝峰法(首字母小寫),例如
tableName
、instance
; - 特例:以雙下劃線
__
打頭的函數(shù)或方法作為魔術(shù)方法,例如__call
和__autoload
;
函數(shù)和方法的區(qū)別:函數(shù)是單獨(dú)存在的,也就是面向過程部分定義的;而方法是依賴于類存在的,也就是面向?qū)ο笾卸x的
常量和配置
- 常量以大寫字母和下劃線命名,例如
APP_PATH
; - 配置參數(shù)以小寫字母和下劃線命名,例如
url_route_on
和url_convert
; - 環(huán)境變量定義使用大寫字母和下劃線命名,例如
APP_DEBUG
;
數(shù)據(jù)表和字段
- 數(shù)據(jù)表和字段采用小寫加下劃線方式命名,并注意字段名不要以下劃線開頭,例如
think_user
表和user_name
字段,不建議使用駝峰和中文作為數(shù)據(jù)表及字段命名。
系統(tǒng)編碼
UTF-8 LF
請理解并盡量遵循以上命名規(guī)范,可以減少在開發(fā)過程中出現(xiàn)不必要的錯(cuò)誤。