### PHP開發規范 **遵從 ThinkPHP 規范** 首先要遵從 ThinkPHP 3.2開發手冊的開發命名規范，如控制器，模型，視圖的命名，大小寫等 在此基礎上補充大家約定好的一些開發規范； **開發代碼規范** 1、函數文件都應該放在 Application\Common\Common\function.php 文件里面，做為全局的可調用的函數； 函數名字采用 C GNU的慣例，命名使用小寫字母和下劃線的方式，例如: > get_client_ip ~~~ /** * 加載配置文件 支持格式轉換 僅支持一級配置 * @param string $file 配置文件名 * @return array */ function load_config($file) { $arr = array(); } ~~~ 2、需要引用非 ThinkPHP 約定的第三方類庫文件或在開發過程中封裝的類庫文件都放在 Application\Common\Util 目錄下面， * 第三方類庫直接創建新的文件夾，調用 * 封裝的類庫只是單文件可以直接放在目錄中 > 類調用方法： > import("Common.Util.ZhenPin.Zhenpin"); // 加載文件 > $zhenpin = new \Zhenpin(); // 實例化類 > $zhenpin->qryProductDetail(); // 調用方法 3、項目中公共的操作方法的封裝，如果是全局的需要的情況，封裝放到Application\Common\Controller\BaseController.class.php 文件里面 4、類命名方法 * 類的方法和屬性命名規范使用駝峰命名，區別于函數命名，例如: > getUserName > _parseType 通常下劃線開頭的方法屬于私有方法； * 類中方法的參數命名，第一個字符使用小寫字母，在首字符后的所有字都按照類命名規則首字符大寫； ~~~ class Goods { private $imgName; // 圖片名 @var array // 獲取圖片信息 public function getImageInfo($imgUrl) { $this->imgName = $imgUrl['name']; } } ~~~ 5、變量的命名 所有字母都使用小寫，使用'_'作為每個詞的分界，例如： > $user_name 6、控制器傳值模版的方法名，參考變量的命名方式，區別于操作方法名稱 > $this->assign('user_list', $result) 7、常量所有字母都必須大寫，單詞間用下劃線分隔 > APP_PATH 8、代碼區間空格 在 "()"括號內不能出現空格，括號外一定有空格，參數之間一定有空格，"="、"." 、";"、"=>"、"as"等符號左右一定有有空格 ~~~ if ($var) { // if } elseif ($body) { // else } else { // end; } ~~~ 9、所有的名稱中，都不能出現數字的方式的命名和拼音的命名，例如，變量 > $var1，$va2, > $dingdan 10、代碼必須保持使用4個空格為標準的縮進，在進行數據庫查詢的時候調用的方法使用比較多，要進行換行，并且縮進，例如： ~~~ $result = M("User") ->field('user.name as uname, user.title as utitle') ->where('type=1 AND status=1') ->order('id desc') ->select(); ~~~ 11、Ajax 返回信息寫法，統一的寫法 三個參數： success 是否成功狀態 code 返回代碼 msg 返回提示信息 ~~~ if ($data) { $result = array("success"=>true, 'code'=>200, 'msg'=>'保存成功！'); } else { $result = array("success"=>false, 'code'=>401, 'msg'=>'保存失敗！'); } $this->ajaxReturn($result); ~~~ * * * * * **開發代碼注釋** 友好的開發更需要有規范化的注釋，因此，約定好幾種開發場景中必須要有相關的注釋加以說明 1、在每一次數據庫操作的代碼前面都要加上相關的說明注釋進行描述說明 ~~~ // 查詢用戶列表 $res = M('User')->select(); ~~~ 2、在封裝的函數和方法的前面都要有詳細的注釋進行描述說明，包含，說明信息，參數信息，返回信息，創建人，時間，如果是更新寫上更新說明 ~~~ /** * 編譯文件 * @param string $filename 文件名 * @return array * @creator jig 2017-3-1 */ ~~~ 3、在類文件的頭部都要有描述說明，包括說明信息，版本號，創建人，日期等 ，在方法前面注明怎么使用說明，參數調用說明，返回說明 ~~~ /** * * API Goods * 電商平臺商品 * Jig 2016-12-9 * */ class Goods { private $imgName; // 圖片名 @var array // 獲取圖片信息 @param $imgUrl 圖片名稱 public function getImageInfo($imgUrl) { $this->imgName = $imgUrl['name']; } } ~~~ **注：**封裝的公共的類方法的一定要有更加相信的使用說明 4、在非本文件內的外部函數和類庫方法調用使用都要加上注釋以說明調用情況 ~~~ $result = object_to_array($obj_data); // 調用封裝函數將對象轉為數組 ~~~ * * * * * **約定一些工作習慣** 1、PHP代碼文件必須以 不帶BOM的 UTF-8 編碼，聲明文件編碼 2、項目的 Framework 目錄下面的文件不要隨意改動，如果出現需要增加文件或者修改的情況，請與團隊成員做請示溝通，約定好后再做修改 3、每天早上上班第一件事情都應該是更新代碼，養成及時更新代碼的習慣 4、每天下班前必須將當天的代碼提交到 SVN, 并且養成寫好注釋的習慣 5、我們的開發遵循開發結構，相關的代碼應該寫在相應的不同架構地方，例如，html 模版文件中，不要寫任何的 Javascript 代碼，在 Public 有合理的目錄結構和文件寫 Javascript 代碼 * * * * * **開發中常用的方法命名** 1、index 默認列表頁面 2、search 搜索結構頁 3、export 導出 4、import 導入 5、view 詳情頁 6、add 新增 7、save 保存新增 8、edit 編輯 9、update 更新編輯 #### 大家有異議和更好的建議，提交到我這里，該頁面也會陸續更新... 一個非常有意思的PHP代碼習慣統計 https://segmentfault.com/a/1190000000443795