# 代碼規范 **狀態碼分類** ~~~ 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(列表) ~~~ **代碼注釋規范** ~~~ /** * 測試方法 * * @ApiTitle (方法名test) * @ApiSummary (測試描述信息) * @ApiAuthor (接口作者) * @ApiMethod (POST) * @ApiRoute (/api/demo/test/) * @ApiHeaders (name=token, type=string, required=true, description="請求的Token") * @ApiParams (name="id", type="integer", required=true, description="會員ID") * @ApiParams (name="name", type="string", required=true, description="用戶名") * @ApiParams (name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}", description="擴展數據") * @ApiReturnParams (name="code", type="integer", required=true, sample="0") * @ApiReturnParams (name="msg", type="string", required=true, sample="返回成功") * @ApiReturnParams (name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}", description="擴展數據返回") * @ApiReturn ({ 'code':'1', 'msg':'返回成功' }) */ public function test() { $this->success('返回成功', $this->request->param()); } ~~~ | 標簽 | 實例 | 說明 | | --- | --- | --- | | @abstract | | 抽象類的變 和方法 | | @access | public, private or protected | 文檔的訪問和使用權限。＠ ccess private表明這個文檔是私有的 | | @author | 小明 | 文檔作者信息 | | @copyright | 名稱時間 | 文檔版權信息 | | @deprecated | Version | 文檔中被廢除的方法 | | @deprec | | 同 @deprecated | | @example | /path/to/example | 文擋的外部保存示例文件的位置 | | @exception | | 文檔中方法拋出的異常，也可參照＠ hrows | | @global | 類型 $globalvarname | 文檔中的全局變量及有關的方法和函數 | | @ignore | | 忽略文檔中指定的關鍵字 | | @internal | | 開發團隊內部信息 | | @link | URL | 類似于lic se ，但還可以通過訪問 地址找到文檔中更多的詳細信息 | | @name | 變量別名 | 為某個變量指定別名 | | @magic | | PHPDoc兼容phpDocumentor的標簽 | | @package | 封裝包的名稱 | 一組相關類、函數封裝的包名稱 | | @param | usemame 用戶名 | 輸入變量含義注釋 | | @return | 如返回bool | 輸出函數返回結果描述，一般不用在vo id 空返回結果的〕的函數中 | | @see | Class Login() | 文件關聯的任何元素（全局變量，包括頁面、類、函數、定義、方法、變量〉 | | @since | version | 記錄什么時候對文檔的哪些部分進行了更改 | | @static | | 記錄靜態類、方法 | | @staticvar | | 在類、函數中使用的靜態變量 | | @subpackage | | 子版本 | | @throws | | 拋出的異常 | | @todo | | 表示文件未完成或者要完善的地方 |