### 目錄和文件 * 目錄使用小寫+下劃線；. * 類庫、函數文件統一以`.php`為后綴； * 類的文件名均以命名空間定義，并且命名空間的路徑和類庫文件所在路徑一致； * 類文件采用駝峰法命名（首字母大寫），其它文件采用小寫+下劃線命名； * **類名和類文件名保持一致**，統一采用駝峰法命名（首字母大寫）； ### 函數和類、屬性命名 * 類的命名采用駝峰法（首字母大寫），例如`User`、`UserType`，默認不需要添加后綴，例如`UserController`應該直接命名為`User`； * 函數的命名使用小寫字母和下劃線（小寫字母開頭）的方式，例如`get_client_ip`； * 控制器內方法命名使用小寫字母和下劃線（小寫字母開頭）的方式，例如`get_client_ip`； * 方法的命名使用駝峰法（首字母小寫），例如`getUserName`； * 屬性的命名使用駝峰法（首字母小寫），例如`tableName`、`instance`； * 特例：以雙下劃線`__`打頭的函數或方法作為魔術方法，例如`__call`和`__autoload`； 函數和方法的區別：*函數*是單獨存在的,也就是面向過程部分定義的;而*方法*是依賴于類存在的,也就是面向對象中定義的 ### 常量和配置 * 常量以大寫字母和下劃線命名，例如`APP_PATH`； * 配置參數以小寫字母和下劃線命名，例如`url_route_on`和`url_convert`； * 環境變量定義使用大寫字母和下劃線命名，例如`APP_DEBUG`； ### 數據表和字段 * 數據表和字段采用小寫加下劃線方式命名，并注意字段名不要以下劃線開頭，例如`think_user`表和`user_name`字段，不建議使用駝峰和中文作為數據表及字段命名。 ### 系統編碼 UTF-8 LF **請理解并盡量遵循以上命名規范，可以減少在開發過程中出現不必要的錯誤。** # 代碼規范 **狀態碼分類** ~~~ HTTP狀態碼分類 分類 分類描述 1** 信息，服務器收到請求，需要請求者繼續執行操作 2** 成功，操作被成功接收并處理 3** 重定向，需要進一步的操作以完成請求 4** 客戶端錯誤，請求包含語法錯誤或無法完成請求 5** 服務器錯誤，服務器在處理請求的過程中發生了錯誤 200 成功 10001 輸入參數錯誤 10002 網絡錯誤 10003 文件錯誤，請檢查是否responseheader是否缺少Content-Length 10004 格式錯誤 10005 系統錯誤 401 500 403 302 -1 未知錯誤 ~~~ **代碼規范** ~~~ 1．提高代碼復用即， 個代碼片段出現過多次，就可以考慮封裝其為公共方法； 3. 接口除了域名外，路徑寫全，方便前端對接 4. 自定義類庫統一放在根目錄下的extend下面, composer類庫放在vendor下面、自定義的函數放在common.php里面 5. 在引用模型或者其他類庫的方法時，注釋一下時干嘛的 ~~~ **類庫引用規范** ~~~ 1. 自定義類庫統一放在根目錄下的extend下面, composer類庫放在vendor下面、自定義的函數放在common.php里面 2. 在引用模型或者其他類庫的方法時，注釋一下時干嘛的 ~~~ **接口返回規范** ~~~ 1.{"code"="1","msg"="返回信息"，"data"="數據"，"time"="數據請求時間" } 2.code=1是成功，失敗的自定義 ~~~ **命名規范** ~~~ 1. 采用駝峰法命名，同樣的方法，命名為 getUserNarne()比命名為 getusernarne()更易于閱讀、采用_命名或者首字母大寫 2. 命名方式必須在整個項目中統一 3. 方法的作用都是執行一個動作，達到一個目的。所以名稱應該說明方法是做什么的。一般名稱的前綴都是有第一規律的，如is（判斷）、get（得到），set（設置），del(刪除)，add(添加)，edit(修改)，show(展示)，details(詳情)、lists(列表) ~~~