php編程規範

標籤：控制   str   開發   風格   傳回值   author   getc   需要   style   

今天寫這個是為了 提醒自己 編程過程 不僅要有邏輯 思想 還有要規範 代碼 這樣可讀性 

感謝我牛神提供的文檔

 

1、PHP 編程規範與編碼習慣最主要的有以下幾點：

 1 檔案說明

 2 function 函數體說明

 3 代碼縮排

 4 if省略

 5 變數規範

 6 命名規範

 7 十行一注釋

 8 注釋風格

 9 開放關閉原則

2、檔案說明 個人代碼 -規範如下:

 1 <? 2 /* 3  +---------------------------------------------------------------------- 4  + Title        : 標題 5  + Author       : 作者 6  + Version      : 版本號碼 7  + Initial-Time : 這個檔案初始建立的時間 8  + Last-time    : 這個檔案最後修改的時間 + 修改人的名稱 9  + Desc         : 這個檔案的簡單描述10  +----------------------------------------------------------------------11 */

3、Function 函數體說明：

 1 <? 2 /** 3  * 函數體簡單的描述 4  * @author_start : 作者 5  * @author_end   : 修改時間 + 修改者 6  * @param string : $id       描述 7  * @param array  : $array  描述 8  * @param array  : $num   描述 9  * @return : 傳回值說明10 */11 function Test($id, $array = array(), $num = 1){12 }

注意:Function裡面變數參數的代碼縮排風格

 4、代碼縮排：

 1 <? 2 $str  = 1; 3 $info = ‘123‘; 4 $version = ‘123123‘; 5 $name = ‘test‘; 6 $i    = ‘haha‘; 7   8 # 一般在最外部的if 或流程式控制制語句都應該上下留空一行 9 if ($info) {10  11 }12  13 # 一般在最外部的for或者 foreach都應該上下留空一行14 for ($i=0 ,$i<6 ,$i++){15  16 }

5、IF省略

 1 <? 2 # 一般在if語句與其分支的流程式控制制語句當中,存在這exit或者return的情況下,都應該省略其else的部分操作 3 # 錯誤 4 if () { 5     return false; 6 } else { 7     return true; 8 } 9 # 正確10 if () {11     return false;12 }13 return true;

6、變數規範，使用英文命名

1 <?2 # 正確3 $title = ‘標題‘;4 $name  = ‘名稱‘;5 $pwd   = ‘密碼‘;6 # 錯誤7 $biaoti = ‘標題‘;8 $ming   = ‘名稱‘;9 $mima   = ‘密碼‘;

7、命名規範

 1 <? 2 /** 3  * 實際開發中，命名方式一般有三種情況 4  * 注意：不管是類名，變數，方法名，在實際開發中，最多隻能是不超過3個單詞的組合 5  * 大駝峰 ：每個單字首大寫 6  * 小駝峰 ：中間單字首大寫  7  * 蛇形   ：每個單詞小寫，單詞與單詞之間使用 _ 符合連結 8  */ 9  10 # 大駝峰，常用於類名定義11 class Car{}12 class BlueCar{}13  14 # 小駝峰，常用於方法名定義15 class Car{16   public function getColor(){}17 }18  19 # 蛇形，常用於變數名定義20 $res_id   = 1;21 $res_name = 2; 

9、注釋風格

 1 <? 2 1、當需要對某段代碼，做大量描述時，使用以下注釋風格 3 /** 4  * 我是說明 5  * ① 流程一 6  * ② 流程二 7  * ③ 流程三 8  */ 9  10 2、當需要對一行代碼，做小量描述時，使用以下注釋風格11 # 這是XXXX給ZZZZ的變數，叫CCCC12 $name = ‘‘;13  14 3、當需要對一行代碼，做簡介描述時，使用以下注釋風格15 $name       = ‘‘; // X表的欄位16 $index_head = ‘‘; // 首頁要求標頭

10、開放關閉原則
     
           實際上這是一個概念，是設計模式中的一種。
           簡單來說，就是一個已經完成上線的class或者api，可以在不改動起原檔案的情況下，對其功能進行外部擴充。

 

php編程規範