1
. 代码 必须 遵循 PSR-1
中的编码规范 。2
. 代码 必须 使用 4 个空格符 而不是「Tab 键」进行缩进。3
. 每行的字符数 应该 软性保持在 80
个之内,理论上 一定不可 多于 120 个,但 一定不可 有硬性限制。4
. 每个 namespace
命名空间声明语句和 use
声明语句块后面,必须 插入一个空白行。5
. 类的开始花括号({
) 必须 写在函数声明后自成一行,结束花括号(}
)也 必须 写在函数主体后自成一行。6
. 方法的开始花括号({
) 必须 写在函数声明后自成一行,结束花括号(}
)也 必须 写在函数主体后自成一行。7
. 类的属性和方法 必须 添加访问修饰符(private
、protected
以及 public
),abstract
以及 final
必须 声明在访问修饰符之前,而 static
必须 声明在访问修饰符之后。8
. 控制结构的关键字后 必须 要有一个空格符,而调用方法或函数时则 一定不可 有。9
. 控制结构的开始花括号({
) 必须 写在声明的同一行,而结束花括号(}
) 必须 写在主体后自成一行。10
. 控制结构的开始左括号后和结束右括号前,都 一定不可 有空格符。1.1 例子
以下例子,展示上述相关规则:
<?php
namespace Vendor\Package;
use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class Foo extends Bar implements FooInterface
{
public function sampleMethod($a, $b = null)
{
if ($a === $b) {
bar();
} elseif ($a > $b) {
$foo->bar($arg1);
} else {
BazClass::bar($arg2, $arg3);
}
}
final public static function bar()
{
// method body
}
}
代码必须符合 PSR-1
中的所有规范。
Unix LF (linefeed)
作为行的结束符。空白行
作为结束。?>
结束标签。代码 必须 使用 4 个空格符
的缩进,一定不可 用 tab
键。
备注:使用空格而不是「tab键缩进」的好处在于, 避免在比较代码差异、打补丁、重阅代码以及注释时产生混淆。 并且,使用空格缩进,让对齐变得更方便。
PHP 所有 关键字 必须 全部小写。
常量 true
、false
和 null
也 必须 全部小写。
namespace
声明后 必须 插入一个空白行。use
必须 在 namespace
后声明。use
声明语句 必须 只有一个 use
关键词。use
声明语句块后 必须 要有一个空白行。代码示例
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
// ... additional PHP code ...
此处的「类」泛指所有的「class类」、「接口」以及「traits 可复用代码块」。
关键词 extends
和 implements
必须 写在类名称的同一行。
类的开始花括号 必须 独占一行,结束花括号也 必须 在类主体后独占一行。
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements \ArrayAccess, \Countable
{
// 这里面是常量、属性、类方法
}
implements
的继承列表也 可以 分成多行,这样的话,每个继承接口名称都 必须 分开独立成行,包括第一个。
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements
\ArrayAccess,
\Countable,
\Serializable
{
// 这里面是常量、属性、类方法
}
var
声明一个属性。protected
或 private
。以下是属性声明的一个范例:
<?php
namespace Vendor\Package;
class ClassName
{
public $foo = null;
}
protected
或 private
。一个标准的方法声明可参照以下范例,留意其括号、逗号、空格以及花括号的位置。
<?php
namespace Vendor\Package;
class ClassName
{
public function fooBarBaz($arg1, &$arg2, $arg3 = [])
{
// method body
}
}
参数列表中,每个逗号后面 必须 要有一个空格,而逗号前面 一定不可 有空格。
有默认值的参数,必须 放到参数列表的末尾。
<?php
namespace Vendor\Package;
class ClassName
{
public function foo($arg1, &$arg2, $arg3 = [])
{
// method body
}
}
参数列表 可以 分列成多行,这样,包括第一个参数在内的每个参数都 必须 单独成行。
拆分成多行的参数列表后,结束括号以及方法开始花括号 必须 写在同一行,中间用一个空格分隔。
<?php
namespace Vendor\Package;
class ClassName
{
public function aVeryLongMethodName(
ClassTypeHint $arg1,
&$arg2,
array $arg3 = []
) {
// 方法的内容
}
}
需要添加 abstract
或 final
声明时,必须 写在访问修饰符前,而 static
则 必须 写在其后。
<?php
namespace Vendor\Package;
abstract class ClassName
{
protected static $foo;
abstract protected function zim();
final public static function bar()
{
// method body
}
}
方法及函数调用时,方法名或函数名与参数左括号之间 一定不可 有空格,参数右括号前也 一定不可 有空格。每个参数前 一定不可 有空格,但其后 必须 有一个空格。
<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);
参数 可以 分列成多行,此时包括第一个参数在内的每个参数都 必须 单独成行。
<?php
$foo->bar(
$longArgument,
$longerArgument,
$muchLongerArgument
);
控制结构关键词后 必须 有一个空格。 >左括号 ( 后 一定不可 有空格。 >右括号 ) 前也 一定不可 有空格。 >右括号 ) 与开始花括号 { 间 必须 有一个空格。 >结构体主体 必须 要有一次缩进。 >结束花括号 } 必须 在结构体主体后单独成行。
每个结构体的主体都 必须 被包含在成对的花括号之中, 这能让结构体更加结构话,以及减少加入新行时,出错的可能性。
标准的 if 结构如下代码所示,请留意「括号」、「空格」以及「花括号」的位置, 注意 else 和 elseif 都与前面的结束花括号在同一行。
<?php
if ($expr1) {
// if body
} elseif ($expr2) {
// elseif body
} else {
// else body;
}
应该 使用关键词 elseif
代替所有 else if
,以使得所有的控制关键字都像是单独的一个词。
标准的 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 语句应该如下所示,注意其「括号」、「空格」以及「花括号」的位置。
<?php
while ($expr) {
// structure body
}
标准的 do while 语句如下所示,同样的,注意其「括号」、「空格」以及「花括号」的位置。
<?php
do {
// structure body;
} while ($expr);
标准的 for 语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。
<?php
for ($i = 0; $i < 10; $i++) {
// for body
}
标准的 foreach 语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。
<?php
foreach ($iterable as $key => $value) {
// foreach body
}
标准的 try catch 语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。
<?php
try {
// try body
} catch (FirstExceptionType $e) {
// catch body
} catch (OtherExceptionType $e) {
// catch body
}
function
后以及关键词 use
的前后都 必须 要有一个空格。<?php
$closureWithArgs = function ($arg1, $arg2) {
// body
};
$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
// body
};
参数列表以及变量列表 可以 分成多行,这样,包括第一个在内的每个参数或变量都 必须 单独成行,而列表的右括号与闭包的开始花括号 必须 放在同一行。
以下几个例子,包含了参数和变量列表被分成多行的多情况。
<?php
$longArgs_noVars = function (
$longArgument,
$longerArgument,
$muchLongerArgument
) {
// body
};
$noArgs_longVars = function () use (
$longVar1,
$longerVar2,
$muchLongerVar3
) {
// body
};
$longArgs_longVars = function (
$longArgument,
$longerArgument,
$muchLongerArgument
) use (
$longVar1,
$longerVar2,
$muchLongerVar3
) {
// body
};
$longArgs_shortVars = function (
$longArgument,
$longerArgument,
$muchLongerArgument
) use ($var1) {
// body
};
$shortArgs_longVars = function ($arg) use (
$longVar1,
$longerVar2,
$muchLongerVar3
) {
// body
};
注意,闭包被直接用作函数或方法调用的参数时,以上规则仍然适用。
<?php
$foo->bar(
$arg1,
function ($arg2) use ($var1) {
// body
},
$arg3
);
以上规范难免有疏忽,其中包括但不仅限于:
1
. 全局变量和常量的定义2
. 函数的定义3
. 操作符和赋值4
. 行内对齐5
. 注释和文档描述块6
. 类名的前缀及后缀7
. 最佳实践本文为 Ellison 个人笔记,文章来自于网络或个人总结,转载无需和我联系,但请注明来自 Ellison`s Blog https://www.ruoxiaozh.com
Laravel 框架中前端如何使用 CSRF Laravel 5.6 单设备登录 Laravel 5.6 使用 UUID CURL 类封装 Laravel Eloquent 必备的实用技巧 提高安全性的最佳 Nginx 配置 Vagrant SSH 的登录总结 Laravel 跨域解决方案 CORS 跨域的概念与 TP5 的解决方案 MySQL 千万级大数据 SQL 查询优化技巧详解 数据库 30 条军规 JavaScript 判断访问客户端是 PC 端还是移动端 PHP 的笛卡尔积算法实现 API 文档编写 - APIDOC Linux MySQL 定时备份并上传到 git 仓库 Laravel 5.5 之 Api Resource Laravel 实现文章浏览次数统计 如何在 Laravel 项目中使用 Swagger 构建 Api 文档 如何编写基于 Swagger-PHP 的 API 文档 网站加载动画 Markdown 语法说明 见过世面的人,从不说这3句话 PHP7 新特性 - 完结篇 阿里云 Redis 开发规范 Nginx 负载均衡设置 PHP 生成随机红包算法 规范的 README 需要哪些内容 PHP 代码规范之 PSR-2 Ubuntu 14/16 下的 Laravel LNMP 线上环境自动部署脚本 PHP 闭包 不会,找人教你就够了? PHP 新特性 - 命名空间