PHP命名規則

參考： http://nowhisky.diandian.com/post/2012-08-12/40033898638

 

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

 1.  類命名

• 使用大寫字母作為詞的分割，其他的字母均使用小寫。
• 名字的首字母使用大寫。
• 不要使用下划線('_')。
• 如：Name、SuperMan、BigClassObject。

2. 類屬性命名

• 屬性命名應該以字符‘m’為前綴。
• 前綴‘m’后采用與類命名一致的規則。
• ‘m’總是在名字的開頭起修飾作用，就像以‘r’開頭表示引用一樣。
• 如：mValue、mLongString等

3. 方法的命名

• 方法的作用都是執行一個動作，達到一個目的。所以名稱應該說明方法是做什么的。一般名稱的前綴都是有第一規律的，如is（判斷）、get（得到），set（設置）。
• 方法的命名第一個單詞的首字母小寫，其后單詞的首字母大寫。。如：

class StartStudy{                       //設置類
        $mLessonOne = "";               //設置類屬性
        $mLessonTwo = "";               //設置類屬性
        function getLessonOne(){        //定義方法，得到屬性mLessonOne的值
            ...
    }
}

4. 方法中參數命名

• 第一個字符使用小寫字母。
• 在首字符后的所有字符都按照類命名規則首字符大寫。
• 如：

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

5. 引用變量

• 引用變量要帶有‘r’前綴。如：

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

6. 變量命名

• 所有字母都使用小寫。
• 使用‘_’作為每個詞的分界。
• 如：$msg_error、$chk_pwd等。
• 臨時變量通常被取名為i，j，k，m和n，它們一般用於整型；c，d，e，s 它們一般用於字符型。
• 實例變量前面需要一個下划線， 首單次小寫，其余單詞首字母大寫。

7. 全局變量

• 全局變量應該帶有前綴‘g’。如：global $gTest。

8. 常量、全局常量

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

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

9. 靜態變量

• 靜態變量應該帶有前綴‘s’。如：

state $sStatus = 1;

10. 函數命名

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

function this_good_idear(){
    ...
}

 

以上的各種命名規則，可以組合一起來使用，如：

class OtherExample{
    $msValue = "";        //該參數既是類屬性，又是靜態變量
}