今天寫這個是為了 提醒自己 編程過程 不僅要有邏輯 思想 還有要規范 代碼 這樣可讀性
1、PHP 編程規范與編碼習慣最主要的有以下幾點:
1 文件說明
2 function 函數體說明
3 代碼縮進
4 if省略
5 變量規范
6 命名規范
7 十行一注釋
8 注釋風格
9 開放關閉原則
2、文件說明 個人代碼 -規范如下:
<? /* +---------------------------------------------------------------------- + Title : 標題 + Author : 作者 + Version : 版本號 + Initial-Time : 這個文件初始創建的時間 + Last-time : 這個文件最后修改的時間 + 修改人的名稱 + Desc : 這個文件的簡單描述 +---------------------------------------------------------------------- */
3、Function 函數體說明:
<? /** * 函數體簡單的描述 * @author_start : 作者 * @author_end : 修改時間 + 修改者 * @param string : $id 描述 * @param array : $array 描述 * @param array : $num 描述 * @return : 返回值說明 */ function Test($id, $array = array(), $num = 1){ }
注意:Function里面變量參數的代碼縮進風格
4、代碼縮進:
<? $str = 1; $info = '123'; $version = '123123'; $name = 'test'; $i = 'haha'; # 一般在最外部的if 或流程控制語句都應該上下留空一行 if ($info) { } # 一般在最外部的for或者 foreach都應該上下留空一行 for ($i=0 ,$i<6 ,$i++){ }
5、IF省略
<? # 一般在if語句與其分支的流程控制語句當中,存在這exit或者return的情況下,都應該省略其else的部分操作 # 錯誤 if () { return false; } else { return true; } # 正確 if () { return false; } return true;
6、變量規范,使用英文命名
<? # 正確 $title = '標題'; $name = '名稱'; $pwd = '密碼'; # 錯誤 $biaoti = '標題'; $ming = '名稱'; $mima = '密碼';
7、命名規范
<? /** * 實際開發中,命名方式一般有三種情況 * 注意:不管是類名,變量,方法名,在實際開發中,最多只能是不超過3個單詞的組合 * 大駝峰 :每個單詞首字母大寫 * 小駝峰 :中間單詞首字母大寫 * 蛇形 :每個單詞小寫,單詞與單詞之間使用 _ 符合鏈接 */ # 大駝峰,常用于類名定義 class Car{} class BlueCar{} # 小駝峰,常用于方法名定義 class Car{ public function getColor(){} } # 蛇形,常用于變量名定義 $res_id = 1; $res_name = 2;
9、注釋風格
<? 1、當需要對某段代碼,做大量描述時,使用以下注釋風格 /** * 我是說明 * ① 流程一 * ② 流程二 * ③ 流程三 */ 2、當需要對一行代碼,做小量描述時,使用以下注釋風格 # 這是XXXX給ZZZZ的變量,叫CCCC $name = ''; 3、當需要對一行代碼,做簡介描述時,使用以下注釋風格 $name = ''; // X表的字段 $index_head = ''; // 首頁請求頭
10、開放關閉原則
實際上這是一個概念,是設計模式中的一種。
簡單來說,就是一個已經完成上線的class或者api,可以在不改動起原文件的情況下,對其功能進行外部擴展。
以上這篇基于php編程規范(詳解)就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支持。
【網站聲明】本站除付費源碼經過測試外,其他素材未做測試,不保證完整性,網站上部分源碼僅限學習交流,請勿用于商業用途。如損害你的權益請聯系客服QQ:2655101040 給予處理,謝謝支持。