A detailed introduction to several points about PHP naming rules

When writing code, a good coding standard can have many unexpected effects for us. For example:

1. Improve our coding efficiency. The neat and uniform code makes it easy for us to copy and paste!

2. Improve the readability of the code.

3. Show our professionalism. Others saw our code and found that the entire code writing process was neat and uniform, and they instantly became impressed!

4. Facilitate team collaboration. Everyone uses the same standard, which eliminates the various writing methods and ensures unified coordination!

#Develop a good habit of writing code in a standardized way

So let’s take a look at what the specifications are?

Files and lines

• PHP code files must start with

• The code must use 4 spaces characters instead of tab keys for indentation;

• PHP code files must be encoded in UTF-8 without BOM;

• Pure PHP code The file must omit the final ?> closing tag;

• All PHP files must end with a blank line;

• All PHP files must Use Unix LF (linefeed) as the line terminator;

• PHP code in the view file (except template code) must use the long tag or = ?> Short output label; other custom labels must not be used.

• There must be no extra spaces after non-blank lines;

• The number of characters in each line should be kept within 80, no There should be more than 120;

• There must not be more than one statement per line.

Classes, methods, attributes

• Namespaces and classes must comply with PSR’s automatic loading specification: PSR-4;

• PHP code should only define declarations such as classes, functions, and constants or other operations that will produce subordinate effects (such as generating file output, importing files, and modifying ini configuration files, etc.), both of which only You can choose one;

• The naming of the class must follow the camel case naming convention of StudlyCaps starting with an uppercase letter;

• The constants in the class must have all letters Upper case, words separated by underscores;

• The method name must comply with camelCase-style lowercase camel case naming convention;

• use statement must be located in the namespace After the declaration, a blank line must be inserted after each namespace declaration block and use declaration block;

• The opening braces ({) of classes and methods must be written in functions It should be on its own line after the declaration, and the closing curly bracket (}) must also be written on its own line after the function body;

• The keywords extends and implements must be written on the same line as the class name;

• Each statement must not define more than one attribute, and the keyword var must not be used to declare an attribute;

• #The attributes and methods of the class must be added Access modifiers (private, protected and public), do not use underscore _ as a prefix to distinguish whether a property is protected or private;

• When you need to add an abstract or final statement, it must be written in the access modifier before the character, and static must be written after it;

• When declaring and calling methods and functions, there must be no space between the method name or function name and the left bracket of the parameter. There must be no spaces after the left bracket and before the right bracket. There must be a space after each comma in the parameter list, and there must be no space before the comma.

PHP naming convention

Control structure

• Control structure transition (else, else if, catch and do...the while) keyword in the while structure and the closing brace (}) of the previous structure must be written on the same line, and there must be a space between them;

• The opening brace ({) of the control structure must be written on the same line as the declaration, and the closing brace (}) must be written on its own line after the body;

• There must be a space after the keyword of the control structure, and there must be a space between the right bracket) and the opening curly bracket {;

• Conditional brackets after the left bracket and before the right bracket There must be no spaces, and there must be a space between the two clauses (after the semicolon);

• The body of each structure must be enclosed in pairs of curly braces middle.

Closure

• The opening brace must be written on the same line as the declaration, and the closing brace must be written immediately on the next line where the body ends;

• When a closure is declared, there must be a space after the keyword function and before and after the keyword use;

• Parameter list and variable list There must be no spaces after the left bracket and before the right bracket;

• In the parameter and variable lists, there must be no spaces before the comma, and there must be a space after the comma.

Variables and keywords

• All PHP keywords must be all lowercase, and the constants true, false and null must also be all lowercase;

• Operators (=, >, ) for variable assignment and comparison (including control structure conditional statements and arrays) must have a space at both ends, but the self-increment (++ ) Decrement (--) There must be no space between the operating variable and the symbol;

• Variable declarations should use lowercase letters separated by underscores, and non-universal word abbreviations should not be used. Spellings or abbreviations other than English should appear;

• There must be no extra spaces at both ends of the variables in the brackets of keywords such as array, emtpy, isset, unset, etc.;

• Array declaration and use should use [] instead of array();

• Need to wrap the declaration of array variables, the array start symbol ([ or array() should be the same as The operator is on the same line. The first element of the array should start on a new line and must be indented from the previous line. The end symbol of the array ([ or ]) must start on a new line and should be the same as the variable. Align the first character

##Don’t forget your original intention, you will always succeed

The above is the detailed content of A detailed introduction to several points about PHP naming rules. For more information, please follow other related articles on the PHP Chinese website!