代码风格规范
本篇规范是 PSR-1 基本代码规范的继承与扩展。 本规范希望通过制定一系列规范化PHP代码的规则，以减少在浏览不同作者的代码时，因代码风格的不同而造成不便。 当多名程序员在多个项目中合作时，就需要一个共同的编码规范， 而本文中的风格规范源自于多个不同项目代码风格的共同特性， 因此，本规范的价值在于我们都遵循这个编码风格，而不是在于它本身。 关键词 “必须”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、 “将会”("SHALL")、“不会”("SHALL NOT")、“应该”("SHOULD")、“不该”("SHOULD NOT")、 “推荐”("RECOMMENDED")、“可以”("MAY")和”可选“("OPTIONAL")的详细描述可参见 RFC 2119 。 1. 概览
- 代码必须遵循 PSR-1 中的编码规范 。
- 代码必须使用4个空格符而不是 tab键 进行缩进。
- 每行的字符数应该软性保持在80个之内， 理论上一定不可多于120个， 但一定不能有硬性限制。
- 每个
namespace命名空间声明语句和use声明语句块后面，必须插入一个空白行。 - 类的开始花括号(
{)必须写在其声明后自成一行，结束花括号(})也必须写在其主体后自成一行。 - 方法的开始花括号(
{)必须写在函数声明后自成一行，结束花括号(})也必须写在函数主体后自成一行。 - 类的属性和方法必须添加访问修饰符（
private、protected以及public），abstract以及final必须声明在访问修饰符之前，而static必须声明在访问修饰符之后。 - 控制结构的关键字后必须要有一个空格符，而调用方法或函数时则一定不能有。
- 控制结构的开始花括号(
{)必须写在声明的同一行，而结束花括号(})必须写在主体后自成一行。 - 控制结构的开始左括号后和结束右括号前，都一定不能有空格符。
1.1. 例子
以下例子程序简单地展示了以上大部分规范：
`<?php </span?>
namespace Vendor\Package;
use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class Foo extends Bar implements FooInterface
{
public function sampleFunction($a</span>, <span class="pl-smi">$b = null)
{
if ($a</span> <span class="pl-k">===</span> <span class="pl-smi">$b) {
bar();
} elseif ($a</span> <span class="pl-k">></span> <span class="pl-smi">$b) {
$foo</span><span class="pl-k">-></span>bar(<span class="pl-smi">$arg1);
} else {
BazClass::bar($arg2</span>, <span class="pl-smi">$arg3);
}
}
final public static function bar()
{
// method body
}
}
</div>2. 通则
---
### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#21-基本编码准则)2.1 基本编码准则
代码**必须**符合 [PSR-1](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-1-basic-coding-standard-cn.md) 中的所有规范。 ### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#22-文件)2.2 文件
所有PHP文件**必须**使用`Unix LF (linefeed)`作为行的结束符。 所有PHP文件**必须**以一个空白行作为结束。 纯PHP代码文件**必须**省略最后的 `?>` 结束标签。 ### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#23-行)2.3. 行
行的长度**一定不能**有硬性的约束。 软性的长度约束**一定**要限制在120个字符以内，若超过此长度，带代码规范检查的编辑器**一定**要发出警告，不过**一定不可**发出错误提示。 每行**不应该**多于80个字符，大于80字符的行**应该**折成多行。 非空行后**一定不能**有多余的空格符。 空行**可以**使得阅读代码更加方便以及有助于代码的分块。 每行**一定不能**存在多于一条语句。 ### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#24-缩进)2.4. 缩进
代码**必须**使用4个空格符的缩进，**一定不能**用 tab键 。 > 备注: 使用空格而不是tab键缩进的好处在于， 避免在比较代码差异、打补丁、重阅代码以及注释时产生混淆。 并且，使用空格缩进，让对齐变得更方便。
### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#25-关键字-以及-truefalsenull)2.5. 关键字 以及 True/False/Null
PHP所有 [关键字](http://php.net/manual/en/reserved.keywords.php)**必须**全部小写。 常量 `true` 、`false` 和 `null` 也**必须**全部小写。 3. namespace 以及 use 声明
---
`namespace` 声明后 必须 插入一个空白行。 所有 `use` 必须 在 `namespace` 后声明。 每条 `use` 声明语句 必须 只有一个 `use` 关键词。 `use` 声明语句块后 必须 要有一个空白行。 例如： <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1"><span class="pl-k">namespace</span> <span class="pl-en">Vendor\Package</span>;</span>
<span class="pl-s1"><span class="pl-k">use</span> <span class="pl-c1">FooClass</span>;</span>
<span class="pl-s1"><span class="pl-k">use</span> <span class="pl-c1">BarClass</span> <span class="pl-k">as</span> <span class="pl-c1">Bar</span>;</span>
<span class="pl-s1"><span class="pl-k">use</span> <span class="pl-c1">OtherVendor\OtherPackage\BazClass</span>;</span>
<span class="pl-s1"><span class="pl-c">// ... additional PHP code ...</span></span>
</span>此处的“类”泛指所有的class类、接口以及traits可复用代码块。 ### 4.1. 扩展与继承
关键词 extends 和 implements必须写在类名称的同一行。 类的开始花括号必须独占一行，结束花括号也必须在类主体后独占一行。
`<?php </span?>
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements \ArrayAccess, \Countable
{
// constants, properties, methods
}
</div> `implements` 的继承列表也**可以**分成多行，这样的话，每个继承接口名称都**必须**分开独立成行，包括第一个。 <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1"><span class="pl-k">namespace</span> <span class="pl-en">Vendor\Package</span>;</span>
<span class="pl-s1"><span class="pl-k">use</span> <span class="pl-c1">FooClass</span>;</span>
<span class="pl-s1"><span class="pl-k">use</span> <span class="pl-c1">BarClass</span> <span class="pl-k">as</span> <span class="pl-c1">Bar</span>;</span>
<span class="pl-s1"><span class="pl-k">use</span> <span class="pl-c1">OtherVendor\OtherPackage\BazClass</span>;</span>
<span class="pl-s1"><span class="pl-k">class</span> <span class="pl-en">ClassName</span> <span class="pl-k">extends</span> <span class="pl-e">ParentClass</span> <span class="pl-k">implements</span></span>
<span class="pl-s1"> <span class="pl-c1">\ArrayAccess</span>,</span>
<span class="pl-s1"> <span class="pl-c1">\Countable</span>,</span>
<span class="pl-s1"> <span class="pl-c1">\Serializable</span></span>
<span class="pl-s1">{</span>
<span class="pl-s1"> <span class="pl-c">// constants, properties, methods</span></span>
<span class="pl-s1">}</span></span>每个属性都必须添加访问修饰符。 一定不可使用关键字 var 声明一个属性。 每条语句一定不可定义超过一个属性。 不要使用下划线作为前缀，来区分属性是 protected 或 private。 以下是属性声明的一个范例：
`<?php </span?>
namespace Vendor\Package;
class ClassName
{
public $foo = null;
}
</div>### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#43-方法)4.3. 方法
所有方法都**必须**添加访问修饰符。 **不要**使用下划线作为前缀，来区分方法是 protected 或 private。 方法名称后**一定不能**有空格符，其开始花括号**必须**独占一行，结束花括号也**必须**在方法主体后单独成一行。参数左括号后和右括号前**一定不能**有空格。 一个标准的方法声明可参照以下范例，留意其括号、逗号、空格以及花括号的位置。 <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1"><span class="pl-k">namespace</span> <span class="pl-en">Vendor\Package</span>;</span>
<span class="pl-s1"><span class="pl-k">class</span> <span class="pl-en">ClassName</span></span>
<span class="pl-s1">{</span>
<span class="pl-s1"> <span class="pl-k">public</span> <span class="pl-k">function</span> <span class="pl-en">fooBarBaz</span>(<span class="pl-smi">$arg1</span>, <span class="pl-k">&</span><span class="pl-smi">$arg2</span>, <span class="pl-smi">$arg3</span> <span class="pl-k">=</span> [])</span>
<span class="pl-s1"> {</span>
<span class="pl-s1"> <span class="pl-c">// method body</span></span>
<span class="pl-s1"> }</span>
<span class="pl-s1">}</span></span>参数列表中，每个逗号后面必须要有一个空格，而逗号前面一定不能有空格。 有默认值的参数，必须放到参数列表的末尾。
`<?php </span?>
namespace Vendor\Package;
class ClassName
{
public function foo($arg1</span>, <span class="pl-k">&</span><span class="pl-smi">$arg2, $arg3 = [])
{
// method body
}
}
</div> 参数列表**可以**分列成多行，这样，包括第一个参数在内的每个参数都**必须**单独成行。 拆分成多行的参数列表后，结束括号以及方法开始花括号 必须 写在同一行，中间用一个空格分隔。 <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1"><span class="pl-k">namespace</span> <span class="pl-en">Vendor\Package</span>;</span>
<span class="pl-s1"><span class="pl-k">class</span> <span class="pl-en">ClassName</span></span>
<span class="pl-s1">{</span>
<span class="pl-s1"> <span class="pl-k">public</span> <span class="pl-k">function</span> <span class="pl-en">aVeryLongMethodName</span>(</span>
<span class="pl-s1"> <span class="pl-c1">ClassTypeHint</span> <span class="pl-smi">$arg1</span>,</span>
<span class="pl-s1"> <span class="pl-k">&</span><span class="pl-smi">$arg2</span>,</span>
<span class="pl-s1"> <span class="pl-k">array</span> <span class="pl-smi">$arg3</span> <span class="pl-k">=</span> []</span>
<span class="pl-s1"> ) {</span>
<span class="pl-s1"> <span class="pl-c">// method body</span></span>
<span class="pl-s1"> }</span>
<span class="pl-s1">}</span></span>abstract 、 final 、 以及 static需要添加 abstract 或 final 声明时， 必须写在访问修饰符前，而 static 则必须写在其后。
`<?php </span?>
namespace Vendor\Package;
abstract class ClassName
{
protected static $foo;
abstract protected function zim();
final public static function bar()
{
// method body
}
}
</div>### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#46-方法及函数调用)4.6. 方法及函数调用
方法及函数调用时，方法名或函数名与参数左括号之间**一定不能**有空格，参数右括号前也 **一定不能**有空格。每个逗号前**一定不能**有空格，但其后**必须**有一个空格。 <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1">bar();</span>
<span class="pl-s1"><span class="pl-smi">$foo</span><span class="pl-k">-></span>bar(<span class="pl-smi">$arg1</span>);</span>
<span class="pl-s1"><span class="pl-c1">Foo</span><span class="pl-k">::</span>bar(<span class="pl-smi">$arg2</span>, <span class="pl-smi">$arg3</span>);</span></span>`<?php </span?>
$foo->bar(
$longArgument,
$longerArgument,
$muchLongerArgument
);
</div>5. 控制结构
---
控制结构的基本规范如下： - 控制结构关键词后**必须**有一个空格。
- 左括号 `(` 后**一定不能**有空格。
- 右括号 `)` 前也**一定不**能有空格。
- 右括号 `)` 与开始花括号 `{` 间**一定**有一个空格。
- 结构体主体**一定**要有一次缩进。
- 结束花括号 `}` **一定**在结构体主体后单独成行。
每个结构体的主体都**必须**被包含在成对的花括号之中， 这能让结构体更加结构话，以及减少加入新行时，出错的可能性。 ### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#51-if--elseif-和-else)5.1. `if` 、 `elseif` 和 `else`
标准的 `if` 结构如下代码所示，留意 括号、空格以及花括号的位置， 注意 `else` 和 `elseif` 都与前面的结束花括号在同一行。 <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1"><span class="pl-k">if</span> (<span class="pl-smi">$expr1</span>) {</span>
<span class="pl-s1"> <span class="pl-c">// if body</span></span>
<span class="pl-s1">} <span class="pl-k">elseif</span> (<span class="pl-smi">$expr2</span>) {</span>
<span class="pl-s1"> <span class="pl-c">// elseif body</span></span>
<span class="pl-s1">} <span class="pl-k">else</span> {</span>
<span class="pl-s1"> <span class="pl-c">// else body;</span></span>
<span class="pl-s1">}</span></span>elseif 代替所有 else if ，以使得所有的控制关键字都像是单独的一个词。 ### 5.2. switch 和 case标准的 switch 结构如下代码所示，留意括号、空格以及花括号的位置。 case 语句必须相对 switch 进行一次缩进，而break 语句以及 case 内的其它语句都 必须 相对 case 进行一次缩进。 如果存在非空的 case 直穿语句，主体里必须有类似// no break 的注释。
`<?php </span?>
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;
}
</div>### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#53-while-和-do-while)5.3. `while` 和 `do while`
一个规范的 `while` 语句应该如下所示，注意其 括号、空格以及花括号的位置。 <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1"><span class="pl-k">while</span> (<span class="pl-smi">$expr</span>) {</span>
<span class="pl-s1"> <span class="pl-c">// structure body</span></span>
<span class="pl-s1">}</span></span>do while 语句如下所示，同样的，注意其 括号、空格以及花括号的位置。 `<?php </span?>
do {
// structure body;
} while ($expr);
</div>### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#54-for)5.4. `for`
标准的 `for` 语句如下所示，注意其 括号、空格以及花括号的位置。 <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1"><span class="pl-k">for</span> (<span class="pl-smi">$i</span> <span class="pl-k">=</span> <span class="pl-c1">0</span>; <span class="pl-smi">$i</span> <span class="pl-k"> <span class="pl-c1">10</span>; <span class="pl-smi">$i</span><span class="pl-k">++</span>) {</span>
<span class="pl-s1"> <span class="pl-c">// for body</span></span>
<span class="pl-s1">}</span></span></span>foreach标准的 foreach 语句如下所示，注意其 括号、空格以及花括号的位置。
`<?php </span?>
foreach ($iterable</span> <span class="pl-k">as</span> <span class="pl-smi">$key => $value) {
// foreach body
}
</div>### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#56-try-catch)5.6. `try`, `catch`
标准的 `try catch` 语句如下所示，注意其 括号、空格以及花括号的位置。 <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1"><span class="pl-k">try</span> {</span>
<span class="pl-s1"> <span class="pl-c">// try body</span></span>
<span class="pl-s1">} <span class="pl-k">catch</span> (<span class="pl-c1">FirstExceptionType</span> <span class="pl-smi">$e</span>) {</span>
<span class="pl-s1"> <span class="pl-c">// catch body</span></span>
<span class="pl-s1">} <span class="pl-k">catch</span> (<span class="pl-c1">OtherExceptionType</span> <span class="pl-smi">$e</span>) {</span>
<span class="pl-s1"> <span class="pl-c">// catch body</span></span>
<span class="pl-s1">}</span></span>闭包声明时，关键词 function 后以及关键词 use 的前后都必须要有一个空格。 开始花括号必须写在声明的同一行，结束花括号必须紧跟主体结束的下一行。 参数列表和变量列表的左括号后以及右括号前，必须不能有空格。 参数和变量列表中，逗号前必须不能有空格，而逗号后必须要有空格。 闭包中有默认值的参数必须放到列表的后面。 标准的闭包声明语句如下所示，注意其 括号、逗号、空格以及花括号的位置。
`<?php </span?>
$closureWithArgs</span> <span class="pl-k">=</span> <span class="pl-k">function</span> (<span class="pl-smi">$arg1, $arg2) {
// body
};
$closureWithArgsAndVars</span> <span class="pl-k">=</span> <span class="pl-k">function</span> (<span class="pl-smi">$arg1, $arg2</span>) <span class="pl-k">use</span> (<span class="pl-smi">$var1, $var2) {
// body
};
</div> 参数列表以及变量列表**可以**分成多行，这样，包括第一个在内的每个参数或变量都**必须**单独成行，而列表的右括号与闭包的开始花括号**必须**放在同一行。 以下几个例子，包含了参数和变量列表被分成多行的多情况。 <div class="highlight highlight-text-html-php"> ```
<span class="pl-pse"><?php </span?>
<span class="pl-s1"><span class="pl-smi">$longArgs_noVars</span> <span class="pl-k">=</span> <span class="pl-k">function</span> (</span>
<span class="pl-s1"> <span class="pl-smi">$longArgument</span>,</span>
<span class="pl-s1"> <span class="pl-smi">$longerArgument</span>,</span>
<span class="pl-s1"> $muchLongerArgument</span>
<span class="pl-s1">) {</span>
<span class="pl-s1"> <span class="pl-c">// body</span></span>
<span class="pl-s1">};</span>
<span class="pl-s1"><span class="pl-smi">$noArgs_longVars</span> <span class="pl-k">=</span> <span class="pl-k">function</span> () <span class="pl-k">use</span> (</span>
<span class="pl-s1"> <span class="pl-smi">$longVar1</span>,</span>
<span class="pl-s1"> <span class="pl-smi">$longerVar2</span>,</span>
<span class="pl-s1"> $muchLongerVar3</span>
<span class="pl-s1">) {</span>
<span class="pl-s1"> <span class="pl-c">// body</span></span>
<span class="pl-s1">};</span>
<span class="pl-s1"><span class="pl-smi">$longArgs_longVars</span> <span class="pl-k">=</span> <span class="pl-k">function</span> (</span>
<span class="pl-s1"> <span class="pl-smi">$longArgument</span>,</span>
<span class="pl-s1"> <span class="pl-smi">$longerArgument</span>,</span>
<span class="pl-s1"> $muchLongerArgument</span>
<span class="pl-s1">) <span class="pl-k">use</span> (</span>
<span class="pl-s1"> <span class="pl-smi">$longVar1</span>,</span>
<span class="pl-s1"> <span class="pl-smi">$longerVar2</span>,</span>
<span class="pl-s1"> $muchLongerVar3</span>
<span class="pl-s1">) {</span>
<span class="pl-s1"> <span class="pl-c">// body</span></span>
<span class="pl-s1">};</span>
<span class="pl-s1"><span class="pl-smi">$longArgs_shortVars</span> <span class="pl-k">=</span> <span class="pl-k">function</span> (</span>
<span class="pl-s1"> <span class="pl-smi">$longArgument</span>,</span>
<span class="pl-s1"> <span class="pl-smi">$longerArgument</span>,</span>
<span class="pl-s1"> $muchLongerArgument</span>
<span class="pl-s1">) <span class="pl-k">use</span> (<span class="pl-smi">$var1</span>) {</span>
<span class="pl-s1"> <span class="pl-c">// body</span></span>
<span class="pl-s1">};</span>
<span class="pl-s1"><span class="pl-smi">$shortArgs_longVars</span> <span class="pl-k">=</span> <span class="pl-k">function</span> (<span class="pl-smi">$arg</span>) <span class="pl-k">use</span> (</span>
<span class="pl-s1"> <span class="pl-smi">$longVar1</span>,</span>
<span class="pl-s1"> <span class="pl-smi">$longerVar2</span>,</span>
<span class="pl-s1"> $muchLongerVar3</span>
<span class="pl-s1">) {</span>
<span class="pl-s1"> <span class="pl-c">// body</span></span>
<span class="pl-s1">};</span></span>`<?php </span?>
$foo->bar(
$arg1,
function ($arg2</span>) <span class="pl-k">use</span> (<span class="pl-smi">$var1) {
// body
},
$arg3
);
</div>7. 总结
---
以上规范难免有疏忽，其中包括但不仅限于： - 全局变量和常量的定义
- 函数的定义
- 操作符和赋值
- 行内对齐
- 注释和文档描述块
- 类名的前缀及后缀
- 最佳实践
本规范之后的修订与扩展将弥补以上不足。 [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#附录-a-问卷调查)附录 A. 问卷调查
------------------------------------------------------------------------------------------------------
为了编写本规范，小组制定了调查问卷，用来统计各成员项目的共同规范。 以下是此问卷调查的数据，在此供查阅。 ### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#a1-问卷数据)A.1. 问卷数据
url,http://www.horde.org/apps/horde/docs/CODING_STANDARDS,http://pear.php.net/manual/en/standards.php,http://solarphp.com/manual/appendix-standards.style,http://framework.zend.com/manual/en/coding-standard.html,http://symfony.com/doc/2.0/contributing/code/standards.html,http://www.ppi.io/docs/coding-standards.html,https://github.com/ezsystems/ezp-next/wiki/codingstandards,http://book.cakephp.org/2.0/en/contributing/cakephp-coding-conventions.html,https://github.com/UnionOfRAD/lithium/wiki/Spec%3A-Coding,http://drupal.org/coding-standards,http://code.google.com/p/sabredav/,http://area51.phpbb.com/docs/31x/coding-guidelines.html,https://docs.google.com/a/zikula.org/document/edit?authkey=CPCU0Us&hgd=1&id=1fcqb93Sn-hR9c0mkN6m_tyWnmEvoswKBtSc0tKkZmJA,http://www.chisimba.com,n/a,https://github.com/Respect/project-info/blob/master/coding-standards-sample.php,n/a,Object Calisthenics for PHP,http://doc.nette.org/en/coding-standard,http://flow3.typo3.org,https://github.com/propelorm/Propel2/wiki/Coding-Standards,http://developer.joomla.org/coding-standards.html
voting,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,no,no,no,?,yes,no,yes
indent_type,4,4,4,4,4,tab,4,tab,tab,2,4,tab,4,4,4,4,4,4,tab,tab,4,tab
line_length_limit_soft,75,75,75,75,no,85,120,120,80,80,80,no,100,80,80,?,?,120,80,120,no,150
line_length_limit_hard,85,85,85,85,no,no,no,no,100,?,no,no,no,100,100,?,120,120,no,no,no,no
class_names,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,lower_under,studly,lower,studly,studly,studly,studly,?,studly,studly,studly
class_brace_line,next,next,next,next,next,same,next,same,same,same,same,next,next,next,next,next,next,next,next,same,next,next
constant_names,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper
true_false_null,lower,lower,lower,lower,lower,lower,lower,lower,lower,upper,lower,lower,lower,upper,lower,lower,lower,lower,lower,upper,lower,lower
method_names,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,lower_under,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel
method_brace_line,next,next,next,next,next,same,next,same,same,same,same,next,next,same,next,next,next,next,next,same,next,next
control_brace_line,same,same,same,same,same,same,next,same,same,same,same,next,same,same,next,same,same,same,same,same,same,next
control_space_after,yes,yes,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes
always_use_control_braces,yes,yes,yes,yes,yes,yes,no,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes
else_elseif_line,same,same,same,same,same,same,next,same,same,next,same,next,same,next,next,same,same,same,same,same,same,next
case_break_indent_from_switch,0/1,0/1,0/1,1/2,1/2,1/2,1/2,1/1,1/1,1/2,1/2,1/1,1/2,1/2,1/2,1/2,1/2,1/2,0/1,1/1,1/2,1/2
function_space_after,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no
closing_php_tag_required,no,no,no,no,no,no,no,no,yes,no,no,no,no,yes,no,no,no,no,no,yes,no,no
line_endings,LF,LF,LF,LF,LF,LF,LF,LF,?,LF,?,LF,LF,LF,LF,?,,LF,?,LF,LF,LF
static_or_visibility_first,static,?,static,either,either,either,visibility,visibility,visibility,either,static,either,?,visibility,?,?,either,either,visibility,visibility,static,?
control_space_parens,no,no,no,no,no,no,yes,no,no,no,no,no,no,yes,?,no,no,no,no,no,no,no
blank_line_after_php,no,no,no,no,yes,no,no,no,no,yes,yes,no,no,yes,?,yes,yes,no,yes,no,yes,no
class_method_control_brace,next/next/same,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/next,same/same/same,same/same/same,same/same/same,same/same/same,next/next/next,next/next/same,next/same/same,next/next/next,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/same,next/next/next
### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#a2-问卷说明)A.2. 问卷说明
`indent_type`: 缩进类型. `tab` = "使用 tab 键一次", `2` or `4` = "空格的数量" `line_length_limit_soft`: 每行字符数量的“软”限制. `?` = 不可辩或无作答, `no` 表示无限制. `line_length_limit_hard`: 每行字符数量的“硬”限制. `?` = 不可辩或无作答, `no` 表示无限制. `class_names`: 类名称的命名. `lower` = 只允许小写字母, `lower_under` = 下滑线分隔的小写字母, `studly` = StudlyCase 的驼峰风格. `class_brace_line`: 类的开始花括号是与 class 关键字在同一行或是在其的下一行？ `constant_names`: 类的常量如何命名? `upper` = 下划线分隔的大写字母. `true_false_null`: 关键字 `true`、`false` 以及 `null` 是全部小写 `lower` 还是全部大写 `upper`? `method_names`: 方法名称如何命名? `camel` = `camelCase`, `lower_under` = 下划线分隔的小写字母. `method_brace_line`: 方法的开始花括号是与方法名在同一行还是在其的下一行？ `control_brace_line`: 控制结构的开始花括号是与声明在同一行还是在其的下一行？ `control_space_after`: 控制结构关键词后是否有空格？ `always_use_control_braces`: 控制结构体是否都要被包含在花括号内？ `else_elseif_line`: `else` 或 `elseif` 与前面的结束花括号在同一行还是在其的下一行？ `case_break_indent_from_switch`: `switch` 语句中的 `case` 和 `break` 需要相对 `switch` 缩进多少次？ `function_space_after`: 函数调用语句中，函数名称与变量列表的左括号间是否有空格？ `closing_php_tag_required`: 纯 PHP 代码的文件，是否需要 `?>` 结束标签？ `line_endings`: 选择哪种类型的行结束符？ `static_or_visibility_first`: 声明一个静态方法时，`static` 是写访问修饰符前还是后？ `control_space_parens`: 控制结构里，左括号后以及右括号前是否有空格？`yes` = `if ( $expr )`, `no` = `if ($expr)`. `blank_line_after_php`: PHP 开始标签后，是否需要一个空行？ `class_method_control_brace`: 开始花括号在类、方法和控制结构的位置统计。 ### [](https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md#a3-问卷统计结果)A.3. 问卷统计结果
indent_type:
tab: 7
2: 1
4: 14line_length_limit_soft:
?: 2
no: 3
75: 4
80: 6
85: 1
100: 1
120: 4
150: 1line_length_limit_hard:
?: 2
no: 11
85: 4
100: 3
120: 2class_names:
?: 1
lower: 1
lower_under: 1
studly: 19class_brace_line:
next: 16
same: 6constant_names:
upper: 22true_false_null:
lower: 19
upper: 3method_names:
camel: 21
lower_under: 1method_brace_line:
next: 15
same: 7control_brace_line:
next: 4
same: 18control_space_after:
no: 2
yes: 20always_use_control_braces:
no: 3
yes: 19else_elseif_line:
next: 6
same: 16case_break_indent_from_switch:
0/1: 4
1/1: 4
1/2: 14function_space_after:
no: 22closing_php_tag_required:
no: 19
yes: 3line_endings:
?: 5
LF: 17static_or_visibility_first:
?: 5
either: 7
static: 4
visibility: 6control_space_parens:
?: 1
no: 19
yes: 2blank_line_after_php:
?: 1
no: 13
yes: 8class_method_control_brace:
next/next/next: 4
next/next/same: 11
next/same/same: 1
same/same/same: 6本文作者： 小罗同学
原文链接： PSR-2 规范
版权声明： 本站所有文章除特别声明外，均采用 BY-NC-SA 许可协议。转载请注明出处！
免责声明： 文中如涉及第三方资源，均来自互联网，仅供学习研究，禁止商业使用，如有侵权，联系我们24小时内删除！
- « 上一篇PSR-1 规范
- 下一篇 »PSR-2 补充文档
评论1
暂时没有评论