PSR-2 代碼風格規範

https://blog.csdn.net/qq_28602957/article/details/52248239

 

這篇規範是PSR-1（基本代碼規範）的擴展和繼承。

本規經過制定一系列規範化PHP代碼的規則，以減小在瀏覽不一樣做者的代碼時，因代碼風格的不一樣而形成不便。

這個風格規範是從各類各樣的項目的共性中延伸出來的。當多名程序員在多個項目中合做時，它有助於有一套準則，在全部的項目中使用。

所以，本指南的好處不是在規則自己，而是在這些規則的共享。

關鍵詞 「必須」(「MUST」)、「必定不可/必定不能」(「MUST NOT」)、「須要」(「REQUIRED」)、 
「將會」(「SHALL」)、「不會」(「SHALL NOT」)、「應該」(「SHOULD」)、「不應」(「SHOULD NOT」)、 
「推薦」(「RECOMMENDED」)、「能夠」(「MAY」)和」可選「(「OPTIONAL」)的詳細描述可參見 RFC 2119

1.概覽

• 代碼必須遵循PSR-1基本代碼規範。
• 代碼必須使用四個空格符進行縮進，而不是一個tab鍵。
• 每行應該保持在80個字符之內，軟限制必須是120個字符，但必定不能有硬性限制。
• 每一個namespace命名空間聲明語句和use聲明語句塊後面，必須有一個空白行。
• 類的開始花括號({)必須寫在函數聲明後自成一行，結束花括號(})也必須寫在函數主體後自成一行。
• 方法的開始花括號({)必須寫在函數聲明後自成一行，結束花括號(})也必須寫在函數主體後自成一行。
• 在全部的屬性和方法上都必須聲明可見性(譯者注：private，protected以及public)；abstract和final必須聲明在可見性以前；static必須聲明在可見性以後。
• 控制結構的關鍵詞後面必須有一個空格符，方法和函數調用必定不能有。
• 控制結構的開始花括號({)必須寫在聲明的同一行，而結束花括號(})必須寫在主體後自成一行。
• 控制結構的開始左括號（{）以後必定不能有空格，右括號(})以前必定不能有空格。

1.1 例子

如下這個例子簡單的展現了以上的大部分規範。

<?php namespace Vendor\Package; use FooInterface; use BarClass as Bar; use OtherVendor\OtherPackage\BazClass; class Foo extends Bar implements FooInterface { public function sampleFunction($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 } } 

 

2. 通則

2.1 基本編碼規範

代碼必須符合PSR-1的全部規範

2.2 文件

全部PHP文件必須使用Unix LF (linefeed)做爲行的結束符。

全部PHP文件必須以一個空白行結束。

純PHP代碼文件必須省略最後的 ?> 結束標籤。

2.3 行

行的長度必定不能有硬性的約束。

行長度的軟性約束必定限制在120個字符之內；若是超過此長度，代碼規範檢查器必須發出警告，必定不能報錯。

每行不該該超過80個字符；超過80個字符的行，應該被拆分紅多個不超過80個字符的後續行。

在非空白行的後面必定不能有多餘的空格符。

空行能夠用來改善可讀性和區分相關的代碼塊。

每行必定不能多餘一條語句。

2.4 縮進

代碼必須使用四個空格符縮進，必定不能使用tab鍵。

備註：只用空格，不於tab混合使用，有助於避免代碼差別、打補丁、重閱代碼以及註釋時產生混淆。使用空格還可使調整細微的縮進來改變對齊變得簡單。

2.5 關鍵字和True/False/Null

PHP關鍵字必須所有小寫。

PHP常量true,false和null**必須**所有小寫。

3. 命名空間以及Use聲明

存在命名空間時，其後面必須有一個空白行。

全部的use，必須在命名空間後聲明。

每條use聲明語句，必須只有一個use關鍵字。

use聲明語句塊後面必須有一個空白行。

例如：

<?php namespace Vendor\Package; use FooClass; use BarClass as Bar; use OtherVendor\OtherPackage\BazClass; // ... additional PHP code ... 

 

4. 類、屬性和方法

此處的「類」泛指全部的class類、接口以及traits可複用代碼塊。

4.1 擴展和繼承

關鍵詞extends和implements必須和類名在同一行。

類開始的花括號（{）必須獨佔一行，類結束的花括號（}）必須在類主體後獨佔一行。

<?php namespace Vendor\Package; use FooClass; use BarClass as Bar; use OtherVendor\OtherPackage\BazClass; class ClassName extends ParentClass implements \ArrayAccess, \Countable { // constants, properties, methods } 

 

implements的接口列表也能夠分紅多行，當這樣作時，列表中的第一個接口必須放在下一行中，每行必須只有一個接口

<?php namespace Vendor\Package; use FooClass; use BarClass as Bar; use OtherVendor\OtherPackage\BazClass; class ClassName extends ParentClass implements \ArrayAccess, \Countable, \Serializable { // constants, properties, methods } 

 

4.2 屬性

全部屬性都必須聲明可見性。

必定不能使用關鍵字var聲明一個屬性。

每條語句必定不能定義超過一個屬性。

屬性名稱不該該以單個下劃線做爲前綴來表示屬性是protected或private。

一個屬性的聲明應該像下面這樣。

<?php namespace Vendor\Package; class ClassName { public $foo = null; } 

 

4.3 方法

全部方法都必須聲明可見性（訪問修飾符）。

方法名稱不該該以單個下劃線做爲前綴來表示是protected或private。

方法名稱後必定不能有空格符，其開始花括號必須獨佔一行，結束花括號也必須在方法主體後單獨成一行。參數左括號後和右括號前必定不能有空格。

一個方法定義應該像下面這樣，注意括號，逗號，空格和花括號的位置：

<?php namespace Vendor\Package; class ClassName { public function fooBarBaz($arg1, &$arg2, $arg3 = []) { // method body } } 

 

4.4 方法參數

在參數列表中，每一個逗號以前必定不能有空格，每一個逗號以後必須有一個空格。

方法參數中，有默認值的，必須放到參數列表的末尾。

<?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 = [] ) { // method body } } 

 

4.5 abstract,final和static

當存在時，abstract和final聲明必須放在可見性以前。

當存在時，static聲明必須放在可見性後。

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

 

4.6 方法和函數調用

方法及函數調用時，方法名或函數名與左括號之間必定不能有空格，參數右括號前也必定不能有空格。在參數列表中，每一個逗號以前必定不能有空格，每一個逗號以後必須有一個空格。

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

 

參數能夠被拆分紅多個有一個縮進的後續行，若是這麼作，參數列表中的第一個必須放在下一行，而且每一行只能有一個參數。

<?php $foo->bar( $longArgument, $longerArgument, $muchLongerArgument ); 

 

5. 控制結構

控制結構基本樣式規範以下：

• 控制結構關鍵詞後必須有一個空格。
• 左括號(後面必定不能有空格。
• 右括號)前必定不能有空格。
• 右括號)和開始花括號{之間必須有一個空格。
• 結構體必須縮進一次。
• 結束花括號}必須在主體後自成一行。

每一個結構體的主題都必須被包含在成對的花括號中，這使結構體看起來更加規範以及減小加入新行時，出錯的可能性。。

5.1 if,elseif,else

一個if的結構以下所示。注意其括號、空格以及花括號的位置，而且else和elseif和前一個主體的結束花括號}在同一行。

<?php if ($expr1) { // if body } elseif ($expr2) { // elseif body } else { // else body; } 

 

應該使用elseif代替else if，使得全部的控制關鍵詞看起來像一個單詞。

5.2 switch和case

一個switch結構以下所示。注意其括號、空格以及花括號的位置。case語句必須相對於switch進行一次縮進，break關鍵字（或其餘終止關鍵字）必須和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; } 

 

5.3 while,do while

一個while語句以下所示。注意其括號、空格以及花括號的位置。

<?php while ($expr) { // structure body }

 

一樣，一個do while語句以下所示。注意其括號、空格以及花括號的位置。

<?php do { // structure body; } while ($expr); 

 

5.4 for

一個for語句看起來像下面這個樣子。注意其括號、空格以及花括號的位置。

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

5.5 foreach

一個foreach語句看起來像下面這樣。注意其括號、空格以及花括號的位置。

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

5.6 try,catch

一個try catch語句塊看起來像下面這樣。注意其括號、空格以及花括號的位置。

<?php try { // try body } catch (FirstExceptionType $e) { // catch body } catch (OtherExceptionType $e) { // catch body }

6. 閉包

閉包聲明時，關鍵詞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 );

7. 結論

有許多元素的風格和實踐在本指南中被故意忽略掉。這些包括但不限於：

• 全局變量和常量的定義
• 函數的定義
• 操做符和賦值
• 行內對齊
• 註釋和文檔描述塊
• 類名的前綴及後綴
• 最佳實踐

將來的建議可能會修改和擴展本指南，以解決這些或其餘元素的風格和實踐。