PSR-12 编码规范扩充
文章转发自专业的Laravel开发者社区，原始连接：learnku.com/laravel/t/3…php
编码风格扩充指南
文章中的关键词 MUST ， MUST NOT ， REQUIRED ， SHALL ， SHALL NOT ， SHOULD ， SHOULD NOT ， RECOMMENDED ， MAY ，和 OPTIONAL 都在 RFC 2119 中进行来解释。html
摘要
此规范起到继承，扩展和替换 [PSR-2][] 的做用， 同时编码风格遵照 [PSR-1][] 这个基础编码标准。 和 [PSR-2][] 同样， 此规范的目的是减小不一样人在阅读代码时认知冲突。 它经过列举一套如何格式化 PHP 代码的公共的规则和指望来实现这个目标。 PSR 力图提供一套方法，编码风格工具能够利用，项目能够遵照，开发人员能够方便的在不一样的项目中使用。当各个的开发人员在进行多项目合做的时候，它能够帮助在这些项目中提供一套通用的指导。因此，本指南的价值不是规则自己，而是这些规则的共享。laravel
[PSR-2][] 在 2012 年被接受，随后 PHP 经历了不少变化，影响了编码风格。同时 [PSR-2] 是 PHP 编码时候的基础功能，被普遍的采用。所以，PSR 力图经过一种更加现代的方式说明 PSR-2 的内容和新功能，并对 PSR-2 进行更正。数组
之前的语言版本
在整个文档中，任何说明均可以被忽略，若是它们不存在于你项目所支持的 PHP 版本中。闭包
例如
此示例包含如下一些规则做为快速概述：app
<?php
declare(strict_types=1);
namespace Vendor\Package;
use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
use Vendor\Package\SomeNamespace\ClassD as D;
use function Vendor\Package\{functionA, functionB, functionC};
use const Vendor\Package\{ConstantA, ConstantB, ConstantC};
class Foo extends Bar implements FooInterface {
public function sampleFunction(int $a, int $b = null): array {
if ($a === $b) {
bar();
} elseif ($a > $b) {
$foo->bar($arg1);
} else {
BazClass::bar($arg2, $arg3);
}
}
final public static function bar() {
// 方法内容
}
}
复制代码
2. 总则
2.1 基本编码标准
代码必须遵循[PSR-1]中列出的全部规则。函数
PSR-1中的术语 'StudlyCaps' 必须解释为 PascalCase （帕斯卡命名法：大驼峰式命名法），其中每一个单词的第一个字母大写，包括第一个字母。工具
2.2 文件
全部 PHP 文件只能使用Unix LF (换行符) 结尾。编码
全部的 PHP 文件都必须以非空行结尾，以一个 LF 结尾。spa
在仅包含 PHP 代码的文件中，必须省略结尾的 ？> 标记。
2.3 代码行
行长度不得有硬限制。
行长度的软限制必须为120个字符。
行的长度不该超过80个字符；超过该长度的行应拆分为多个后续行，每一个行的长度不该超过80个字符。
行尾不能有尾随空格。
能够添加空行以提升可读性并指示相关的代码块，除非明确禁止。
每行不能有多个语句。
2.4 缩进
代码必须为每一个缩进级别使用4个空格的缩进，而且不能使用缩进标签。
2.5 关键词和类型
PHP将来版本中新加的全部关键字和类型也都必须使用小写。
类型关键字必须使用缩写。使用 bool 而不是 boolean，使用 int 而不是 integer 等等。
3. 声明、命名空间以及导入
一个PHP文件的头部可能会包含多个块。若是包含多个块，则每一个块都必须用空白行和其余块分隔，而且块内不能包含空白行。全部的块都必须按照下面的顺序排列，若是不存在该块则忽略。
- PHP文件开始标签：
<?php。 - 文件级文档块。
- 一个或多个声明语句。
- 命名空间声明语句。
- 一个或多个基于类的
use声明语句。 - 一个或多个基于方法的
use声明语句。 - 一个或多个基于常量的
use声明语句。 - 其他代码。
当文件包含HTML和PHP的混合代码时，可使用上面列出的任何部分。若是是这种状况的话，即时代码的其余部分包含有PHP结束符，而后再包含HTML和PHP代码，声明、命名空间和导入语句块也必须放在文件的顶部。
何时开始 <？php 标签位于文件的第一行，它必须位于本身的行，没有其余语句，除非它是一个包含 PHP 以外的标记的文件打开和关闭标记。
import语句不能之前导反斜杠开头，由于它们必须始终彻底合格。
如下示例演示了全部块的完整列表：
<?php
/** * This file contains an example of coding styles. */
declare(strict_types=1);
namespace Vendor\Package;
use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
use Vendor\Package\SomeNamespace\ClassD as D;
use Vendor\Package\AnotherNamespace\ClassE as E;
use function Vendor\Package\{functionA, functionB, functionC};
use function Another\Vendor\functionD;
use const Vendor\Package\{CONSTANT_A, CONSTANT_B, CONSTANT_C};
use const Another\Vendor\CONSTANT_D;
/** * FooBar is an example class. */
class FooBar {
// ... 其余php代码 ...
}
复制代码
深度不能超过两层的复合名称空间，所以如下展现了容许的最大复合深度。
<?php
use Vendor\Package\SomeNamespace\{
SubnamespaceOne\ClassA,
SubnamespaceOne\ClassB,
SubnamespaceTwo\ClassY,
ClassZ,
};
复制代码
而且不容许如下内容:
<?php
use Vendor\Package\SomeNamespace\{
SubnamespaceOne\AnotherNamespace\ClassA,
SubnamespaceOne\ClassB,
ClassZ,
};
复制代码
当但愿在 PHP 外部包含标记的文件中声明严格类型时打开和关闭标签，声明必须写在文件的第一行而且包含在一个开始的 PHP 标签，以及严格的类型声明和结束标签。
例如:
<?php declare(strict_types=1) ?>
<html>
<body>
<?php
// ... 其余 PHP 代码 ...
?>
</body>
</html>
复制代码
声明语句不能包含空格，而且必须彻底是 declare(strict_types=1) (带有可选的分号终止符)。
容许使用块声明语句，而且必须按照如下的格式设置。注意的位置括号和间距：
declare(ticks=1) {
// 一些代码
}
复制代码
4. 类，属性，和方法
这里的『类』指的是全部类，接口，以及 trait 。
任何注释和语句 不得 跟在其右花括号后的同一行。
当实例化一个类时，后面的圆括号 必须 写出来，即便没有参数传进其构造函数。
new Foo();
复制代码
4.1 继承和实现
关键字 继承 和 实现 必须 在类名的同一行声明。
类的左花括号 必须 另起一行；右花括号 必须 跟在类主体的下一行。
类的左花括号 必须 独自成行，且 不得 在其上一行或下一行存在空行。
右花括号 必须 独自成行，且 不得 在其上一行存在空行。
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements \ArrayAccess, \Countable {
// 常量，属性，方法
}
复制代码
若是有接口， 实现 接口和 继承父类 能够 分为多行，前者每行需缩进一次。当这么作时，第一个接口 必须 写在下一行，且每行 必须 只能写一个接口。
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements \ArrayAccess, \Countable, \Serializable {
// 常量，属性，方法
}
复制代码
4.2 使用 trait
在类里面用于实现 trait 的关键字 use 必须 在左花括号的下一行声明。
<?php
namespace Vendor\Package;
use Vendor\Package\FirstTrait;
class ClassName {
use FirstTrait;
}
复制代码
每一个导入类的 trait 必须 每行一个包含声明，且每一个包含声明 必须 有其 use 导入语句。
<?php
namespace Vendor\Package;
use Vendor\Package\FirstTrait;
use Vendor\Package\SecondTrait;
use Vendor\Package\ThirdTrait;
class ClassName {
use FirstTrait;
use SecondTrait;
use ThirdTrait;
}
复制代码
在类文件中，若是在使用'use Trait'以后没有其余内容了 ，类名右大括号必须另起一行。
<?php
namespace Vendor\Package;
use Vendor\Package\FirstTrait;
class ClassName {
use FirstTrait;
}
复制代码
若有其余内容，二者之间需空一行。
<?php
namespace Vendor\Package;
use Vendor\Package\FirstTrait;
class ClassName {
use FirstTrait;
private $property;
}
复制代码
当使用' insteadof '和' as '运算符时，它们必须如图所示使用，注意缩进、间距和另起一行。
<?php
class Talker {
use A, B, C {
B::smallTalk insteadof A;
A::bigTalk insteadof C;
C::mediumTalk as FooBar;
}
}
复制代码
4.3 属性和常量
全部属性 必须 声明可见性。
若是你的项目 PHP 最小版本支持常量可见性（ PHP 7.1 或以上），全部常量 必须 声明可见性。
关键字 var 不得 用于声明属性。
每条声明语句 不得 声明多于一个属性。
属性名 不得 用单个下划线开头代表其受保护的或私有的可见性。也就是说，一个下划线开头显然是没有意义的。
类型声明和属性名之间 必须 有一个空格。
一个属性声明看上去以下所示：
<?php
namespace Vendor\Package;
class ClassName {
public $foo = null;
public static int $bar = 0;
}
复制代码
4.4 方法和函数
全部的方法 必须 事先声明类型。
方法命名 必定不可 用单个下划线来区分是 protected 或 private 类型。也就是说，不要用一个没有意义的下划线开头。
方法和函数名称中，方法命名后面 必定不可 使用空格。方法开始的花括号 必须 写在方法声明后自成一行， 结束花括号也 必须 写在方法后面自成一行。开始左括号后和结束右括号前，都 必定不可 有空格符。
一个方法的声明应该以下所示。注意括号，逗号，空格和花括号的位置：
<?php
namespace Vendor\Package;
class ClassName {
public function fooBarBaz($arg1, &$arg2, $arg3 = []) {
// 方法主体
}
}
复制代码
一个函数的声明应该以下所示。注意括号，逗号，空格和花括号的位置：
<?php
function fooBarBaz($arg1, &$arg2, $arg3 = []) {
// 函数主体
}
复制代码
4.5 方法和函数参数
在参数列表中， 不得 在每一个逗号前存在空格，且 必须 在每一个逗号后有一个空格。
方法和函数中带有默认值的参数 必须 放在参数列表的最后。
<?php
namespace Vendor\Package;
class ClassName {
public function foo(int $arg1, &$arg2, $arg3 = []) {
// 方法主体
}
}
复制代码
参数列表 能够 分为多行，每行参数缩进一次。当这么作时，第一个参数 必须 放在下一行，且每行 必须 只能有一个参数。
当参数列表分红多行时，右圆括号和左花括号 必须 放在同一行且单独成行，二者之间存在一个空格。
<?php
namespace Vendor\Package;
class ClassName {
public function aVeryLongMethodName( ClassTypeHint $arg1, &$arg2, array $arg3 = [] ) {
// 方法主体
}
}
复制代码
当你定义一个返回值类型声明时，冒号后面的类型声明 必须 用空格符隔开。冒号和声明 必须 在同一行，且跟参数列表后的结束括号之间没有空格。
<?php
declare(strict_types=1);
namespace Vendor\Package;
class ReturnTypeVariations {
public function functionName(int $arg1, $arg2): string {
return 'foo';
}
public function anotherFunction( string $foo, string $bar, int $baz ): string {
return 'foo';
}
}
复制代码
在可空类型声明中，问号和类型声明之间不能有空格。
<?php
declare(strict_types=1);
namespace Vendor\Package;
class ReturnTypeVariations {
public function functionName(?string $arg1, ?int &$arg2): ?string {
return 'foo';
}
}
复制代码
当在参数以前使用引用运算符 & 时，引用运算符以后不能有空格，例如上面的示例。
可变参数声明的三个点和参数名称之间不能有空格：
public function process(string $algorithm, ...$parts) {
// 函数体
}
复制代码
当同时使用引用运算符和可变参数运算符时，它们之间不能有任何空格：
public function process(string $algorithm, &...$parts) {
// 函数体
}
复制代码
4.6 abstract, final, and static
若是是 abstract and final ，那么申明的时候必须是可见性声明。
若是是 static ，声明必须位于可见性声明以后。
<?php
namespace Vendor\Package;
abstract class ClassName {
protected static $foo;
abstract protected function zim();
final public static function bar() {
// 请求体
}
}
复制代码
4.7 方法和函数的调用
当咱们在进行方法或者函数调用的时候，方法或函数与左括号之间不能出现空格，在右括号以后也不能出现空格，而且在右括号以前也必定不能有空格。在参数列表中，每一个逗号前面必定不能有空格，每一个逗号后面也必定不能有空格。
<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);
复制代码
参数列表能够分为多行，每行后面缩进一次。这个作以后，列表中的第一行必须位于下一行，而且每一行必须只有一个参数。跨多个行拆分单个参数(就像匿名函数或者数组那样)并不构成拆分参数列表自己。
<?php
$foo->bar(
$longArgument,
$longerArgument,
$muchLongerArgument
);
复制代码
<?php
somefunction($foo, $bar, [
// ...
], $baz);
$app->get('/hello/{name}', function ($name) use ($app) {
return 'Hello ' . $app->escape($name);
});
复制代码
5. 流程控制
以下是主要的流程控制风格规则：
- 流程控制关键词以后 必须 要有一个空格
- 左括号后面 不能 有空格
- 右括号前面 不能 有空格
- 右括号与左大括号之间 必须 要有一个空格
- 流程主体 必须 要缩进一次
- 流程主体 必须 在左大括号以后另起一行
- 右大括号 必须 在流程主体以后另起一行
每一个流程控制主体 必须 以封闭的括号结束。这将标准化流程结构，同时减小因为流程中添加新的内容而引入错误的可能性。
5.1 if, elseif, else
if 结构以下。注意括号，空格，和大括号的位置；else 和 elseif 都在同一行，和右大括号同样在主体的前面。
<?php
if ($expr1) {
// if body
} elseif ($expr2) {
// elseif body
} else {
// else body;
}
复制代码
关键词 elseif 应该 替换 else if，这样控制关键词看起来像一个词。
括号中的表达式 可能 会被分开为多行，每一行至少缩进一次。若是这样作，第一个条件 必须 在新的一行。右括号和左大括号 必须 在同一行，并且中间有一个空格。条件中间的布尔控制符 必须 在每一行的开头或者结尾，而不是混在一块儿。
<?php
if (
$expr1
&& $expr2
) {
// if body
} elseif (
$expr3
&& $expr4
) {
// elseif body
}
复制代码
5.2 switch, case
switch 结构以下。注意括号，空格和大括号的位置。case 必须 缩进一次从switch开始， break 关键词 (或者其余终止关键词) 必须 缩进和 care 主体保持一致。必须 要有一个像 // 不终止 这样的注释在不为空且继续的 care 主体之中。
<?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;
}
复制代码
括号中的表达式 可能 会被分开多行，每一行至少要缩进一次。若是这样作，第一个条件 必须 在新的一行。右括号和左大括号 必须 在同一行，并且中间有一个空格。条件中间的布尔控制符 必须 在没一行的开头或者结尾，而不是混在一块儿。
<?php
switch (
$expr1
&& $expr2
) {
// structure body
}
复制代码
5.3 while, do while
while 结构以下。注意括号，空格和大括号的位置。
<?php
while ($expr) {
// structure body
}
复制代码
括号中的表达式 可能 会被分开多行，没一行至少要缩进一次。若是这样作，第一个条件 必须 在新的一行。右括号和左大括号 必须 在同一行，并且中间有一个空格。条件中间的布尔控制符 必须 在没一行的开头或者结尾，而不是混在一块儿。
<?php
while (
$expr1
&& $expr2
) {
// structure body
}
复制代码
一样的， do while 申明以下。注意括号，空格和大括号的位置。
<?php
do {
// structure body;
} while ($expr);
复制代码
括号中的表达式 可能 会被分开多行，没一行至少要缩进一次。若是这样作，第一个条件 必须 在新的一行。条件中间的布尔控制符 必须 在每一行的开头或者结尾，而不是混在一块儿。
<?php
do {
// structure body;
} while (
$expr1
&& $expr2
);
复制代码
5.4 for
for 申明以下。注意括号，空格和大括号的位置。
<?php
for ($i = 0; $i < 10; $i++) {
// for body
}
复制代码
括号中的表达式 可能 会被分开多行，每一行至少要缩进一次。若是这样作，第一个条件 必须 在新的一行。右括号和左大括号 必须 在同一行，并且中间有一个空格。
<?php
for (
$i = 0;
$i < 10;
$i++
) {
// for body
}
复制代码
5.5 foreach
foreach 语句的写法以下所示。请注意它的圆括号、空格和花括号。
<?php
foreach ($iterable as $key => $value) {
// 迭代主体
}
复制代码
5.6 try ， catch ， finally
一个 try-catch-finally 模块包含下面这些内容。请注意它的圆括号、空格和花括号。
<?php
try {
// try 主体
} catch (FirstThrowableType $e) {
// 捕获异常主体
} catch (OtherThrowableType | AnotherThrowableType $e) {
// 捕获异常主体
} finally {
// finally 主体
}
复制代码
6. 运算符
运算符的样式规则按元数分组（其接受的操做数个数）。
当运算符周围容许出现空格时， 能够 出于可读性目的打多个空格。
全部这里没描述的运算符暂不做限定。
6.1. 一元运算符
递增 / 递减运算符和操做数之间 不得 有任何空格。
$i++;
++$j;
复制代码
类型转换运算符的圆括号内部 不得 有任何空格：
$intValue = (int) $input;
复制代码
6.2. 二元运算符
全部二进制 算术，比较，赋值，按位，逻辑、字符串和类型运算符必须在先后跟至少一个空格：
if ($a === $b) {
$foo = $bar ?? $a ?? $b;
} elseif ($a > $b) {
$foo = $a + $b * $c;
}
复制代码
6.3. 三元运算符
条件运算符，也称为三元运算符，必须在 ? 和 :这两个字符之间：
$variable = $foo ? 'foo' : 'bar';
复制代码
若是省略条件运算符的中间操做数，运算符必须遵循与其余二进制比较运算符相同的样式规则：
$variable = $foo ?: 'bar';
复制代码
7. 闭包（Closures）
闭包声明时必须在 function 关键字后留有1个空格，而且在 use 关键字先后各留有1个空格。
左花括号必须跟随前文写在同一行，右花括号必须在函数体后换行放置。
不能在参数和变量的左括号后和右括号前放置空格。
不能在参数和变量的逗号前放置空格，但必须在逗号后放置1个空格。
闭包参数若是有默认值，该参数必须放在参数列表末尾。
若是声明了返回类型，它必须遵循普通函数和方法相同的规则；若是使用 use 关键字，冒号必须在 use 右括号后且冒号先后不能有空格。
闭包的声明方式以下，留意括号，逗号，空格和花括号：
<?php
$closureWithArgs = function ($arg1, $arg2) {
// 函数体
};
$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
// 函数体
};
$closureWithArgsVarsAndReturn = function ($arg1, $arg2) use ($var1, $var2): bool {
// 函数体
};
复制代码
参数和变量能够分多行放置，每一个后续行缩进一次。执行此操做时，列表中的第一项必须放在下一行，而且每行只能有一个参数或变量。
结束多行列表（或者参数，变量）的时候，右括号和左大括号 必须 要放在一行，并且中间有一个空格。
下面是有和没有多行参数列表与变量列表的闭包示例。
<?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
);
复制代码
8. 匿名类
匿名类 必须 遵循上面章节中和闭包同样的方针和准则。
<?php
$instance = new class {};
复制代码
只要 implements 接口列表不换行，左花括号 能够 和关键字 class 在同一行。若是接口列表换行，花括号 必须 放在最后一个接口的下一行。
<?php
// 花括号在同一行
$instance = new class extends \Foo implements \HandleableInterface {
// 类内容
};
// 花括号在下一行
$instance = new class extends \Foo implements \ArrayAccess, \Countable, \Serializable {
// 类内容
};
复制代码
- 1. PSR-12 编码规范扩充
- 2. 编码规范
- 3. 规范-编码
- 4. 编码规范-
- 5. 【代码规范】常见编码规范
- 6. php 编码规范
- 7. HTML编码规范
- 8. JavaScript 编码规范
- 9. C#编码规范
- 10. java编码规范
- 更多相关文章...
- • XML 编码 - XML 教程
- • RDF 规则 - RDF 教程
- • Scala 中文乱码解决
- • IntelliJ IDEA代码格式化设置
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. PSR-12 编码规范扩充
- 2. 编码规范
- 3. 规范-编码
- 4. 编码规范-
- 5. 【代码规范】常见编码规范
- 6. php 编码规范
- 7. HTML编码规范
- 8. JavaScript 编码规范
- 9. C#编码规范
- 10. java编码规范