PHP 代码规范

PHP 代码规范

（一）关于「能愿动词」的使用

文档大量使用了「能愿动词」，为了避免歧义，对应的解释如下：

1、必须 (MUST)：绝对，严格遵循，请照做，无条件遵守；

2、一定不可 (MUST NOT)：禁令，严令禁止；

3、应该 (SHOULD) ：强烈建议这样做，但是不强求；

4、不该 (SHOULD NOT)：强烈不建议这样做，但是不强求；

5、可以 (MAY) 和 可选 (OPTIONAL) ：选择性高一点，在这个文档内，此词语使用较少；

 

（二）概览

1、代码 必须 使用4个空格符而不是「Tab 键」进行缩进。

2、每行的字符数 应该 软性保持在 80 个之内，理论上 一定不可 多于 120 个，但 一定不可 有硬性限制。

3、每个 namespace 命名空间声明语句和 use 声明语句块后面，必须 插入一个空白行。

4、类的开始花括号（{） 必须 写在函数声明后自成一行，结束花括号（}）也 必须 写在函数主体后自成一行。

5、方法的开始花括号（{） 必须 写在函数声明后自成一行，结束花括号（}）也 必须 写在函数主体后自成一行。

6、类的属性和方法 必须 添加访问修饰符（private、protected 以及 public），abstract 以及 final 必须 声明在访问修饰符之前，而 static 必须 声明在访问修饰符之后。

7、控制结构的关键字后 必须 要有一个空格符，而调用方法或函数时则 一定不可 有。

8、控制结构的开始花括号（{） 必须 写在声明的同一行，而结束花括号（}） 必须 写在主体后自成一行。

9、控制结构的开始左括号后和结束右括号前，都 一定不可 有空格符。

（三）通则

1、文件

1）所有PHP文件 必须 使用 Unix LF (linefeed) 作为行的结束符。

2）所有PHP文件 必须 以一个空白行作为结束。

3）纯PHP代码文件 必须 省略最后的 ?> 结束标签。

2、行

1）行的长度 一定不可 有硬性的约束。

2）软性的长度约束 必须 要限制在 120 个字符以内，若超过此长度，带代码规范检查的编辑器 必须 要发出警告，不过 一定不可 发出错误提示。

3）每行 不该 多于80个字符，大于80字符的行 应该 折成多行。

4）非空行后 一定不可 有多余的空格符。

5）空行 可以 使得阅读代码更加方便以及有助于代码的分块。

6）每行 一定不可 存在多于一条语句。

3、 缩进

1）代码 必须 使用4个空格符的缩进，一定不可 用 tab键。

备注：使用空格而不是「tab键缩进」的好处在于， 避免在比较代码差异、打补丁、重阅代码以及注释时产生混淆。 并且，使用空格缩进，让对齐变得更方便。

4、关键字 以及 True/False/Null

1）PHP所有关键字 必须 全部小写。

2）常量 true 、false 和 null 也 必须 全部小写。

（四）namespace 以及 use 声明

1、namespace 声明后 必须 插入一个空白行。

2、所有 use 必须 在 namespace 后声明。

3、每条 use 声明语句 必须 只有一个 use 关键词。

4、use 声明语句块后 必须 要有一个空白行。

（五）类、属性和方法

此处的「类」泛指所有的「class类」「接口」以及「traits 可复用代码块」。

1、扩展与继承

1）关键词 extends 和 implements 必须 写在类名称的同一行。

2）类的开始花括号 必须 独占一行，结束花括号也 必须 在类主体后独占一行。

3）implements 的继承列表也 可以 分成多行，这样的话，每个继承接口名称都 必须 分开独立成行，包括第一个。

2、属性

1）每个属性都 必须 添加访问修饰符。

2）一定不可 使用关键字 var 声明一个属性。

3）每条语句 一定不可 定义超过一个属性。

4）不该 使用下划线作为前缀，来区分属性是 protected 或 private。

3、方法

1）所有方法都 必须 添加访问修饰符。

2）不该 使用下划线作为前缀，来区分方法是 protected 或 private。

3）方法名称后 一定不可 有空格符，其开始花括号 必须 独占一行，结束花括号也 必须 在方法主体后单独成一行。参数左括号后和右括号前 一定不可 有空格。

4、方法的参数

1）参数列表中，每个逗号后面 必须 要有一个空格，而逗号前面 一定不可 有空格。

2）有默认值的参数，必须 放到参数列表的末尾。

3）参数列表 可以 分列成多行，这样，包括第一个参数在内的每个参数都 必须 单独成行。

4）拆分成多行的参数列表后，结束括号以及方法开始花括号 必须 写在同一行，中间用一个空格分隔。

5、abstract 、 final 、 以及 static

1）需要添加 abstract 或 final 声明时，必须 写在访问修饰符前，而 static 则 必须 写在其后。

6、方法及函数调用

1）方法及函数调用时，方法名或函数名与参数左括号之间 一定不可 有空格，参数右括号前也 一定不可 有空格。

2）每个参数前 一定不可 有空格，但其后 必须 有一个空格。

3）参数 可以 分列成多行，此时包括第一个参数在内的每个参数都 必须 单独成行。

（六）控制结构

1、控制结构关键词后 必须 有一个空格。

2、左括号 ( 后 一定不可 有空格。

3、右括号 ) 前也 一定不可 有空格。

4、右括号 ) 与开始花括号 { 间 必须 有一个空格。

5、结构体主体 必须 要有一次缩进。

6、结束花括号 } 必须 在结构体主体后单独成行。

7、每个结构体的主体都 必须 被包含在成对的花括号之中， 这能让结构体更加标准化，以及减少加入新行时，出错的可能性。

（七）闭包

1、闭包声明时，关键词 function 后以及关键词 use 的前后都 必须 要有一个空格。

2、开始花括号 必须 写在声明的同一行，结束花括号 必须 紧跟主体结束的下一行。

3、参数列表和变量列表的左括号后以及右括号前，一定不可 有空格。

4、参数和变量列表中，逗号前 一定不可 有空格，而逗号后 必须 要有空格。

5、闭包中有默认值的参数 必须 放到列表的后面。

6、参数列表以及变量列表 可以 分成多行，这样，包括第一个在内的每个参数或变量都 必须 单独成行，而列表的右括号与闭包的开始花括号 必须 放在同一行。

注意，闭包被直接用作函数或方法调用的参数时，以上规则仍然适用。