PHP 规范之编程规范

概述

本规范希望通过制定一系列规范化PHP代码的规则，以减少在浏览不同作者的代码时，因代码风格的不同而造成不便。

当多名程序员在多个项目中合作时，就需要一个共同的编码规范，而本文中的风格规范源自于多个不同项目代码风格的共同特性，因此，本规范的价值在于我们都遵循这个编码风格，而不是在于它本身。

本文档的预期读者PHP开发人员。

本文档适用于大型商用项目。

详细规范文档下载：https://mystudy1.oss-cn-shenz...

文档截图：

文件夹

文件夹名称必须符合CamelCase式的大写字母开头驼峰命名规范。

文件

PHP代码文件必须以不带BOM的 UTF-8 编码。
纯PHP代码文件必须省略最后的 ?> 结束标签。

行

行的长度一定限制在140个字符以内。
非空行后一定不能有多余的空格符。
每行一定不能存在多于一条语句。
适当空行可以使得阅读代码更加方便以及有助于代码的分块（但注意不能滥用空行）。

缩进

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

关键字以及 true/false/null

PHP所有关键字必须全部小写。
常量 true、false和 null必须全部小写。

namespace以及use声明

namespace 声明后必须插入一个空白行。
所有use必须在namespace 后声明。
每条use声明语句必须只有一个use关键词。
use 声明语句块后必须要有一个空白行。

例如：

<?php
namespace VendorgiPackage;
use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackageBazClass;
// ... additional PHP code ...

类（class），属性（properties）和方法（methods）

l 这里的类是广义的类，它包含所有的类（classes），接口（interface）和traits；

类（class）

l 类的命名必须遵循大写字母开头的驼峰式命名规范。

<?php
namespace VendorgiPackage;
class ClassName
{
    // constants, properties, methods
}

extends 和 implements

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

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

<?php
namespace VendorgiPackage;
use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackage\BazClass;
class ClassName extends ParentClass implements giArrayAccess, \Countable
{
    // constants, properties, methods
}

l implements的继承列表如果超出140个字符也可以分成多行，这样的话，每个继承接口名称都必须分开独立成行，包括第一个。

<?php
namespace VendorgiPackage;
use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackage\BazClass;
class ClassName extends ParentClass implements
    giArrayAccess,
    giCountable,
    giSerializable
{
    // constants, properties, methods
}

常量

l 类的常量中所有字母都必须大写，词间以下划线分隔。参照以下代码：

<?php
namespace VendorgiPackage;
use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackage\BazClass;
class ClassName extends ParentClass implements giArrayAccess, \Countable
{
    const VSESION = '1.0';
    const SITE_URL = 'http://www.xxx.com ';
}

属性

l 类的属性命名必须遵循小写字母开头的驼峰式命名规范 ($camelCase)。

l 必须对所有属性设置访问控制（如，public，protect，private）。

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

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

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

l 定义属性时先常量属性再变量属性，先public 然后 protected，最后private。

以下是属性声明的一个范例：

<?php
namespace VendorgiPackage;
class ClassName
{
    const VSESION = '1.0';
public $foo = null;
protected $sex;
private $name;
}

方法

l 方法名称必须符合 camelCase() 式的小写字母开头驼峰命名规范。

l 所有方法都必须设置访问控制（如，public，protect，private）。

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

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

一个标准的方法声明可参照以下范例，留意其括号、逗号、空格以及花括号的位置。

<?php
namespace VendorgiPackage;
class ClassName
{
    public function fooBarBaz($storeName, $storeId, array $info = [])
    {
        // method body
    }
}

方法参数

l 方法参数名称必须符合 camelCase 式的小写字母开头驼峰命名规范

l 参数列表中，每个参数后面必须要有一个空格，而前面一定不能有空格。

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

l 如果参数类型为对像必须指定参数类型为具体的类名，如下的$bazObj参数。

l 如果参数类型为array必须指定参数类型为array。如下$info。

<?php
namespace VendorgiPackage;
class ClassName
{
    public function foo($storeName, $storeId, BazClass $bazObj, array $info = [])
    {
        // method body
    }
}

l 参数列表超过140个字符可以分列成多行，这样，包括第一个参数在内的每个参数都必须单独成行。

l 拆分成多行的参数列表后，结束括号以及最后一个参数必须写在同一行，其开始花括号必须独占一行，结束花括号也必须在方法主体后单独成一行。

<?php
namespace VendorgiPackage;
class ClassName
{
    public function aVeryLongMethodName(
        ClassTypeHint $arg1,
        &$arg2,
        array $arg3 = []) 
    {
        // method body
    }
}

abstract 、 final 、以及 static

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

<?php
namespace VendorgiPackage;
abstract class ClassName
{
    protected static $foo;
    abstract protected function zim();
    final public static function bar()
    {
        // method body
    }
}

方法及方法调用

l 方法及方法调用时，方法名与参数左括号之间一定不能有空格，参数右括号前也一定不能有空格。每个参数前一定不能有空格，但其后必须有一个空格。

<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);

l 参数列表超过140个字符可以分列成多行，此时包括第一个参数在内的每个参数都必须单独成行。

<?php
$foo->bar(

$longArgument,
$longerArgument,
$muchLongerArgument);

控制结构（control structures）

控制结构的基本规范如下：

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

l 左括号 ( 后一定不能有空格。

l 右括号 ) 前也一定不能有空格。

l 右括号 ) 与开始花括号 { 间一定有一个空格。

l 结构体主体一定要有一次缩进。

l 结束花括号 } 一定在结构体主体后单独成行。

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

if、elseif 和 else

l 标准的 if 结构如下代码所示，留意括号、空格以及花括号的位置，注意 else 和 elseif 都与前面的结束花括号在同一行。

<?php
if ($expr1) {
    // if body
} elseif ($expr2) {
    // elseif body
} else {
    // else body;
}
// 
单个
if
也必须带有花括号
if ($expr1) {
    // if body
}

应该使用关键词elseif 代替所有 else if ，以使得所有的控制关键字都像是单独的一个词。

switch和 case

l 标准的 switch 结构如下代码所示，留意括号、空格以及花括号的位置。 case 语句必须相对switch 进行一次缩进，而 break 语句以及 case 内的其它语句都必须相对 case 进行一次缩进。如果存在非空的 case 直穿语句，主体里必须有类似 // no break 的注释。

<?php
switch ($expr) {
    case 0:
        echo 'First case, with a break';
        break;
    case 1:
        echo 'Second case, which falls through';
        // no break
    case 2:
    case 3:
    case 4:
        echo 'Third case, return instead of break';
        return;
    default:
        echo 'Default case';
        break;
}

while 和 do while

l 一个规范的 while 语句应该如下所示，注意其括号、空格以及花括号的位置。

<?php
while ($expr) {

// structure body

}

l 标准的 do while 语句如下所示，同样的，注意其括号、空格以及花括号的位置。

<?php
do {

// structure body;

} while ($expr);

for
l 标准的 for 语句如下所示，注意其括号、空格以及花括号的位置。

<?php
for ($i = 0; $i < 10; $i++) {

// for body

}

foreach

.1.5. foreach
l 标准的 foreach 语句如下所示，注意其括号、空格以及花括号的位置。

<?php
foreach ($iterable as $key => $value) {

// foreach body

}

try catch

l 标准的 try catch 语句如下所示，注意其括号、空格以及花括号的位置。

<?php
try {

// try body

} catch (FirstExceptionType $e) {

// catch body

} catch (OtherExceptionType $e) {

// catch body

}

闭包

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

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

l 参数列表和变量列表的左括号后以及右括号前，必须不能有空格。

l 参数和变量列表中，逗号前必须不能有空格，而逗号后必须要有空格。

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

l 标准的闭包声明语句如下所示，注意其括号、逗号、空格以及花括号的位置。

<?php
$closureWithArgs = function ($arg1, $arg2) 
{
    // body
};
$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) 
{
    // body
};

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

以下几个例子，包含了参数和变量列表被分成多行的多情况。

<?php
$longArgsNoVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument)
{
   // body
};
$noArgsLongVars = function () use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3) 
{
   // body
};
$longArgsLongVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3) 
{
   // body
};
$longArgsShortVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use ($var1) 
{
   // body
};
$shortArgsLongVars = function ($arg) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) 
{
   // body
};

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

<?php
$foo->bar(

$arg1,
function ($arg2) use ($var1) 
{
    // body
},
$arg3);

注释

文件注释
l 注释开始 / 不可以 /，结束 / 不可以 /。

l 第二行php版本信息，版本信息后一空行。

l 注解内容对齐，注解之间不可有空行。

l 星号和注释内容中间必须是一个空格。

l 保持注解顺序一致@copyright然后　@ link　再　@ license。

类注释
l 注释开始 / 不可以 /，结束/ 不可以 /。

l 第二行开始描述，描述后一空行。

l 注解内容对齐，注解之间不可有空行。

l 星号和注释内容中间必须是一个空格。

l 保持注解顺序一致@author然后@since再@version。

属性注释
l 注释开始 / 不可以 /，结束/ 不可以 /。

l 星号和注释内容中间必须是一个空格。

l 使用var注解并注明类型。

l 注解基本类型包括int、sting、array、boolea、具体类名称。

方法注释
l 注释开始 / 不可以 /，结束/ 不可以 /。

l 第二行开始方法描述，方法描述后一空行。

l 注解内容对齐，注解之间不可有空行。

l 星号和注释内容中间必须是一个空格。

l 注解顺序为@param，@return，@author和@since，参数的顺序必须与方法参数顺序一致。

l 参数和返回值注解包括基本类型（int sting array boolean和unknown）和对象，如果多个可能类型使用|分割。

l 如果参数类型为对像必须指定参数类型为具体的类名，如下的$arg1参数。

l 如果参数类型为array必须指定参数类型为array。如下$arg2。

l 需要作者和日期注解，日期为最后修改日期。

其他注释
l 代码注释尽量使用 //

l 注释内容开始前必须一个空格

l 代码行尾注释//前面必须一个空格

l 代码注释与下面的代码对齐

PHP 规范之编程规范

概述

文件夹

文件

行

缩进

关键字以及 true/false/null

namespace以及use声明

类（class），属性（properties）和方法（methods）

类（class）

extends 和 implements

常量

属性

方法

方法参数

abstract 、 final 、以及 static

方法及方法调用

控制结构（control structures）

if、elseif 和 else

switch和 case

while 和 do while

foreach

try catch

闭包

注释

李志健

引用和评论

前后端分离的问题与解决方案

如何实现一个楼中楼的评论系统

Just for fun——迅速写完快速排序

这些年

php-fpm reload 会取消正在处理的请求的解决方案

一个用JavaScript生成思维导图(mindmap)的github repo

从零开始 Elasticsearh Docker 单机集群

PHP 规范之编程规范

概述

文件夹

文件

行

缩进

关键字以及 true/false/null

namespace以及use声明

类（class），属性（properties）和方法（methods）

类（class）

extends 和 implements

常量

属性

方法

方法参数

abstract 、 final 、 以及 static

方法及方法调用

控制结构（control structures）

if、elseif 和 else

switch和 case

while 和 do while

foreach

try catch

闭包

注释

李志健

引用和评论

前后端分离的问题与解决方案

如何实现一个楼中楼的评论系统

Just for fun——迅速写完快速排序

这些年

php-fpm reload 会取消正在处理的请求的解决方案

一个用JavaScript生成思维导图(mindmap)的github repo

从零开始 Elasticsearh Docker 单机集群

abstract 、 final 、以及 static