PHP coding standards and suggestions for newbies

If you want to be an excellent programmer, good coding standards are very important. So how can you write good code? In this article, we will give you some PHP coding standards and suggestions.

Coding specifications

• PHP code files must start with the

        

         Copy after login
        
       

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

例sublime, setting增加，"show_encoding" : true

• The number of characters per line should not exceed 80 characters

例，sublime "word_wrap": "true", "wrap_width": 80,

• Tap key 4 spaces

例，sublime "tab_size": 4,

• Only classes (traits) should be defined in PHP code /Function/Constant/Other operations that will produce side effects (such as generating file output and modifying .ini configuration files, etc.), you can only choose one.

例， a.php class A { } b.php function demo() { } c.php define('A', value); d.php ini_set('some_vars', value);

• The naming of classes/trait/Interface must follow the StudlyCaps camel case naming convention starting with an uppercase letter.

class StudlyCaps { } trait StudlyCaps { } Interface StudlyCaps { }

• Constants in a class must have all letters in capital letters, and words separated by underscores.

define('FOO_BAR', 'something more'); const FOO_BAR = value;

• The method name (in class/trait) must conform to the camelCase-style camel case naming convention starting with lowercase.

class StudlyCaps { public function studlyCaps() { // coding... } }

• Function names must conform to the snake_case-style underscore naming convention.

function snake_case() { // coding... }

• Private (private) method (in class/trait) name must conform to _camelCase-style leading underscore lowercase beginning camel case Naming conventions.

class StudlyCaps { private function _studlyCaps() { // coding... } }

• The first word of the method name is a verb.

class StudlyCaps { public function doSomething() { // coding... } }

• Variables must conform to the camelCase-style naming convention of camel case starting with lowercase.

class StudlyCaps { public function doSomething() { $someVariable = 'demo'; // coding... } }

• When a method/function has multiple parameters, there must be a space between them

class StudlyCaps { public function doSomething($variableOne, $variableTwo) { // coding... } }

• ##Operator/expression must have a space

$a = $b + $c; $a = $b . $c;

Copy after login

• each A blank line must be inserted after the namespace declaration block and the use declaration block.

namespace Standard; // 空一行 use Test\TestClass;//use引入类 // 空一行

Copy after login

• The opening curly brace "{"must be written on a line after the function declaration, and the closing curly brace"}" is also It must be written on its own line after the function body.

class StudlyCaps { }

Copy after login

• The opening curly brace { of the method/function must be written on its own line after the function declaration, and the closing curly brace} must also be written On a line of its own after the function body.

class StudlyCaps { public function studlyCaps() { // coding... } } function snake_case() { // coding... }

Copy after login

• The attributes and methods of the class must be added with access modifiers (private, protected and public), abstract and final must be declared during access before the modifier, and static must be declared after the access modifier.

abstract class StudlyCaps { abstract public function studlyCaps(); final public static function studlyCapsOne() { } }

Copy after login

• There must be a space after the keyword of the control structure, but there must not be when calling a method or function.

if ($valueOne === $valueTwo) { // code... } switch ($valueThree) { case 'value': // code... break; default: // code... break; } do { // code... } while ($valueFour <= 10); while ($valueFive <= 10) { // code... } for ($i = 0; $i < $valueSix; $i++) { // code... } $demo = new Demo() $demo->doSomething(); do_something();

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

if ($valueOne === $valueTwo) { // code... } switch ($valueThree) { case 'value': // code... break; default: // code... break; } do { // code... } while ($valueFour <= 10); while ($valueFive <= 10) { // code... } for ($i = 0; $i < $valueSix; $i++) { // code... }