PHP specific analysis on naming rules

As far as general conventions are concerned, the names of classes, functions, and variables should be such that code readers can easily know the function of these codes, and ambiguous naming should be avoided.

1. Class naming

• Use uppercase letters to separate words, and use lowercase letters for other letters.

• Use capital letters for the first letter of the name.

• Do not use underscore ('_').

• Such as: Name, SuperMan, BigClassObject.

2. Class attribute naming

• The attribute naming should be prefixed with the character ‘m’.

• The prefix ‘m’ follows the same rules as class naming.

• ‘m’ always modifies the beginning of a name, just like ‘r’ represents a reference.

• Such as: mValue, mLongString, etc.

##3. Naming of methods

• The function of methods is to perform an action and achieve a goal. So the name should describe what the method does. Generally, the prefixes of names have first rules, such as is (judgment), get (get), set (set).

• The first letter of the first word in the name of the method is lowercase, and the first letter of the subsequent words is capitalized. . For example:

class StartStudy{                       //设置类
        $mLessonOne = "";               //设置类属性
        $mLessonTwo = "";               //设置类属性
        function getLessonOne(){        //定义方法，得到属性mLessonOne的值
            ...
    }
}

4. Name the parameters in the method

• first characters using lowercase letters.

• All characters after the first character are capitalized according to the class naming rules.

• For example:

##

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

5. Reference variables

Reference variables must be prefixed with 'r'. For example:

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

6. Use all letters in variable naming

lower case.
Use ‘_’ as a delimiter for each word.
For example: $msg_error, $chk_pwd, etc.
Temporary variables are usually named i, j, k, m and n, which are generally used for integers; c, d, e, s, which are generally used for character types.
Instance variables need to be preceded by an underscore, the first letter of the word is lowercase, and the first letter of the remaining words is capitalized.

7. Global variables

Global variables should be prefixed with ‘g’. Such as: global $gTest.

8. Constants and global constants

##Constants and global constants should all be in uppercase letters between words. Use '_' to separate. Such as

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

9. Static variables

Static variables should have Prefix 's'. For example:

state $sStatus = 1;

10. Function naming

All names are Use lowercase letters and use '_' to separate multiple words. For example:

function this_good_idear(){
    ...
}

The various naming rules above can be used in combination, such as:

class OtherExample{
    $msValue = "";        //该参数既是类属性，又是静态变量
}

The above is the detailed content of PHP specific analysis on naming rules. For more information, please follow other related articles on the PHP Chinese website!