> 以下章節的規范定義, 必須遵循官方文檔的推薦為準來定義
**目錄和文件**
* 目錄不強制規范，駝峰及小寫+下劃線模式均支持
* 類庫、函數文件統一以.php為后綴
* 類的文件名均以命名空間定義，并且命名空間的路徑和類庫文件所在路徑一致
* 類名和類文件名保持一致，統一采用駝峰法命名（首字母大寫）
**函數和類、屬性命名**
* 類的命名采用駝峰法，并且首字母大寫，例如 User、UserType，默認不需要添加后綴，例如UserController應該直接命名為User
* 函數(存放在common.php)的命名使用小寫字母和下劃線（小寫字母開頭）的方式，例如 get\_client\_ip
* 方法(業務類)的命名使用駝峰法，并且首字母小寫，例如 getUserName
* 屬性的命名使用駝峰法，并且首字母小寫，例如 tableName、instance
* 實例化類盡量不要使用全路徑的命名空間來實例化, 盡量使用use別名
* 實例化model , service , 必須使用統一命名規范:如:userModel = new User()
```
* 不允許跨模塊調用控制器方法
```
**函數、方法和類注釋**
>類注釋
```
/**
* Created by ${PRODUCT_NAME}.
* author wangwenjie.
* email: 1127031353@qq.com
* Date: ${DATE}
* Time: ${TIME}
*/
```
>函數和方法注釋
```
/**
* Notes:
* User: wangwenjie
* Date: ${DATE}
* Time: ${TIME}
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
*/
```
**常量和配置**
* 常量以大寫字母和下劃線命名，例如 APP\_PATH和 THINK\_PATH；
* 配置參數以小寫字母和下劃線命名，例如 url\_route\_on 和url\_convert；
**其他規范**
* 第三方成熟類庫, 必須使用composer進行集成, 不支持composer的類庫或者是第三方平臺的sdk在模塊中的libraries目錄進行集成
* 所有日志必須使用框架日志類來創建, 根據級別去設定等級區分(自定義日志部分, 暫不考慮, 后期根據項目再按實際情況去做目錄和規范的定義)
* 中間件的使用說明必須詳細, 比如:使用的場景和作用域
* 對于定時任務, 都是基于命令行的方式來實現, 不允許使用url訪問的方式來實現
