php編碼規範

編碼規範目錄

1. 註釋規範 2

2. 代碼規範 3

3. 數據庫規範 3

4. 接口規範 3

5. 文件規範 3

6. 性能規範 4

 

1. 註釋規範

 a.大段註釋採用/**/的方式，一般爲文件或函數的頂部，代碼內部使用'//'；

      b.註釋不宜太多；代碼註釋應該描述爲何而不是作什麼，給代碼閱讀者提供最主要的信息。

 C.所屬本身的文件只在開始部分註釋、非所屬修改請在行類註釋本身的名字

所屬

/**

 * function_name //方法名

 * @author kilvn //建立人

 * @date 2016-10-10 //建立時間

 * @version 1.0.0 //當前程序版本

 * @param string or array //所需參數

 * @paramdemo 2 or array('1', '2') //參數demo

*/

// test controller

非所屬

// test controller by kilvn

 

2. 代碼規範

 a.類或方法的命名:類名(採用駝峯式除框架),方法名均使用小寫，不使用下劃線，儘可能使用英文的組合；

 b.類或方法開始和結束符號位置

 c.變量均小寫（沒有規定的均使用小寫）

Class one_class
{
    function funtion_name()
    {
        //..
    }
}

 

3. 數據庫規範

 a.數據庫字段名稱均使用小寫,保證前臺字段、sql查詢、數據庫字段名稱和大小寫一致；

 B.tinyint 1個字段長度 （適用於狀態） int(適用於時間戳特殊需求能夠用datetime)

   Varchar(適用於中文字段長度例如登陸名) text（編輯器內容）  

 C.數據庫字段註釋(必須) 

 d.數據表(使用utf-8) 必須加表描述和責任人

 例如:DEFAULT CHARSET=utf8 COMMENT='表描述 by kilvn'; 

 

4. 接口規範

 a.接口傳入參數和返回參數均使用小寫（包括現有擴展接口）；

 b.接口類和方法請遵照上面命名規則

 

5. 文件規範

 a.腳本命名均使用小寫加英文組合；

 b.標準文檔（如接口） 請保持 xxx20161010.doc  這樣的格式

 c.升級文件超過一個且未在同一目錄，請從nginx制定目錄向下整理目錄層級和文件

 d.替換或直接修改服務器文件須要備份原有文件，原文件命名 xxx.20161010.kilvn.xx（php）

 

6. 性能規範

a.使用$row[‘id’]方式取數據，不要使用$row[id]方式;

b.緣由：$row[‘id’]的效率是$row[id]的7倍。

c.純字符串使用單引號包含。緣由：PHP會在雙引號包圍的字符串中搜尋變量，單引號則不會。

d.刪除未使用的變量

e.緣由：僅定義一個局部變量而沒在函數中調用它，一樣會減慢速度（其程度至關於遞增一個局部變量）。PHP大概會檢查看是否存在全局變量。

f.執行for循環以前肯定最大循環數，不要每循環一次都計算最大值。

g.循環內部不要聲明變量，尤爲是大變量：對象(語言通用)。

h.執行字符串替換前用strpos()函數判斷是否存在後再執行替換函數。

i.效率：若是須要替換：效率幾乎相等，差異在 0.1% 左右;若是不須要替換：用 strops() 快 200%。

j.用foreach代替while遍歷數組。遍歷數組時foreach的效率明顯高於while循環

k.str_replace函數比preg_replace函數快，但strtr函數的效率是str_replace函數的四倍

l.當執行變量$i的遞增或遞減時，$i++會比++$i慢一些。這種差別是PHP特有的

m.用@屏蔽錯誤消息的作法很是低效