PHP命名規範

Rain Man發表於2014-05-28
PHP

以下文字全部摘自《PHP從入門到精通》這本書，謹以此作為標準。

就一般約定而言，類、函式和變數的名字應該是能夠讓程式碼閱讀者能夠容易地知道這些程式碼的作用，應該避免使用凌磨兩可的命名。

1. 類命名

  • 使用大寫字母作為詞的分割，其他的字母均使用小寫。
  • 名字的首字母使用大寫。
  • 不要使用下劃線('_')。

如：Name、SuperMan、BigClassObject。

2. 類屬性命名

屬性名命名採用駝峰命名法（首字母小寫，後續單詞首字母大寫），私有屬性使用'_'開始。如：$tablePrefix，$_tablePrefix

3. 類方法命名

方法的作用都是執行一個動作，達到一個目的。所以名稱應該說明方法是做什麼的。一般名稱的字首都是有第一規律的，如is（判斷）、get（得到），set（設定）。

方法的的命名採用駝峰命名法（首字母小寫，後續單詞首字母大寫）， 如：getUserName()\ parseLayout()

4. 方法中引數命名

引數命名採用駝峰命名法（首字母小寫，後續單詞首字母大寫）。如

class EchoAnyWord{
    function echoWord($firstWord, $secondWord){
        ...
    }
}

5. 變數命名

  • 所有字母都使用小寫。
  • 使用‘_’作為每個詞的分界。

如：$msg_error、$chk_pwd等。

6. 引用變數

引用變數要帶有‘r’字首。如：

class Example{
    $mExam = "";
    funciton SetExam(&$rExam){
        ...
    }
    function $rGetExam(){
        ...
    }
}

7. 全域性變數

全域性變數應該帶有字首‘g’。如：global = $gTest、global = $g。

8. 常量、全域性常量

常量、全域性常量，應該全部使用大寫字母，單詞之間用‘_’來分割。如

define('DEFAULT_NUM_AVE',90);
define('DEFAULT_NUM_SUM',500);

9. 靜態變數

靜態變數應該帶有字首‘s’。如：

station $sStatus = 1;

10. 函式命名

所有的名稱都使用小寫字母，多個單詞使用‘_’來分割。如：

function this_good_idear(){
    ...
}

參考：PHP命名規則

相關文章