PHP PSR-2 程式碼風格規範

程式碼風格規範

本篇規範是 [PSR-1][] 基本程式碼規範的繼承與擴充。

本規範希望透過制定一系列規範化php程式碼的規則，以減少在瀏覽不同作者的程式碼時，因程式碼風格的不同而造成不便。

當多名程式設計師在多個專案中合作時，就需要一個共同的編碼規範，
而本文中的風格規範源自於多個不同專案程式碼風格的共同特性，
因此，本規範的價值在於我們都遵循這個編碼風格，而不是在於它本身。

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

概覽

---

代碼必須遵循 [PSR-1][] 中的編碼規範 。

代碼必須使用4個空格符而不是 tab鍵 進行縮排。

每行的字元數應該軟性保持在80個之內， 理論上一定不可多於120個， 但一定不能有硬性限制。

每個 namespace 命名空間宣告語句和 use 宣告語句區塊後面，必須插入一個空白行。

類別的開始花括號({)必須寫在函數宣告後自成一行，結束花括號(})也必須寫在函數主體後自成一行。

方法的開始花括號({)必須寫在函數宣告後自成一行，結束花括號(})也必須寫在函數主體後自成一行。

類別的屬性和方法必須新增存取修飾符（private、protected 以及public），abstract 以及final 必須宣告在存取修飾符之前，而static 必須宣告在存取修飾符之後。

控制結構的關鍵字後必須要有一個空格符，而呼叫方法或函數時則一定不能有。

控制結構的開始花括號({)必須寫在宣告的同一行，而結束花括號(})必須寫在主體後自成一行。

控制結構的開始左括號後和結束右括號前，都一定不能有空格符。

1.1. 例子

以下範例程式簡單地展示了上述大部分規格：

namespace VendorPackage;

use FooInterface;
use FooInterface;use BarClass as Bar;
use OtherVendorOtherPackageBazClass;

class Foo extends Bar implements FooInterface
{
 public function sampleFunction($a, $b = null)
 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.1 基本編碼準則

代碼必須符合 [PSR-1][] 中的所有規範。

2.2 文件

所有PHP檔案必須使用Unix LF (linefeed)作為行的結束符號。

所有PHP檔案必須以一個空白行作為結束。

純PHP程式碼檔案必須省略最後的 ?> 結束標籤。

2.3. 行

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

軟性的長度約束一定要限制在120個字以內，若超過此長度，帶代碼規範檢查的編輯器一定要發出警告，不過一定不可發出錯誤提示。

每行不應該多於80個字符，大於80字符的行應該折成多行。

非空白行後一定不能有多餘的空格符。

空白行可以使得閱讀程式碼更方便以及有助於程式碼的分塊。

每行一定不能存在多於一條語句。

2.4. 縮排

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

備註: 使用空格而不是tab鍵縮排的好處在於，
避免在比較程式碼差異、打補丁、重閱程式碼以及註解時產生混淆。
並且，使用空格縮進，讓對齊變得更方便。

2.5. 關鍵字 以及 True/False/Null

PHP所有 [關鍵字][]必須全部小寫。

常數 true 、false 和 null 也必須全部小寫。

namespace 以及 use 聲明

---

namespace 宣告後 必須 插入一行空白。

所有 use 必須 在 namespace 後聲明。

每個 use 宣告語句 必須 只有一個 use 關鍵字。

use 宣告語句區塊後 必須 要有一個空白行。

例如：

namespace VendorPackage;

use FooClass;
use BarClass as

use FooClass;
use BarClass as as

複製程式碼

---

複製程式碼

複製程式碼

類、屬性和方法 此處的「類別」泛指所有的class類別、介面以及traits可重複使用程式碼區塊。 4.1. 擴展與繼承

關鍵字 extends 和 implements

類別的開始花括號
必須
獨佔一行，結束花括號也
必須
在類主體後面獨佔一行。





namespace VendorPackage;

OClass as Barsa>

class ClassName extends ParentClass implements ArrayAccess, Countable{ // constants, properties, methods}

複製程式碼可以
分成多行，這樣的話，每個繼承介面名稱都
必須
分開獨立成行，包括第一個。





namespace VendorPackage;

use FooClass;

ArrayAccess,

Countable, Serializable{

// constants, properties, methods

{ // constants, properties, methods{

// constants, properties, methods

} // constants, properties, methods}

// constants, properties, methods

} // constants, pro>代碼

4.2. 屬性

每個屬性都

必須

一定不可
使用關鍵字 var 宣告一個屬性。

每個語句
一定不可
定義超過一個屬性。

以下是屬性宣告的範例：

namespace VendorPackage;

class ClassName

{{ public $foo = null;}複製程式碼4.3. 方法

所有方法都

必須

新增存取修飾符。

使用底線作為前綴，來區分方法是 protected 或 private。

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

4.4. 方法的參數

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

有預設值的參數，必須放到參數清單的末端。

namespace VendorPackage;

class ClassName
{
 public function foo($arg1, &128($22 $理解可以
分列成多行，這樣，包括第一個參數在內的每個參數都
必須
單獨成行。

namespace VendorPackage;class ClassName{

public function aVery​​L類, ClassfVer

&$arg2,

array $arg3 = []

}


複製程式碼
}


複製程式碼
}


複製程式碼
}

複製程式碼}

複製程式碼

複製碼
4.5. abstract 、 final 、 以及static
需要加入 abstract 或 final 宣告時，
必須
寫在存取修飾符前，而 static 則
必須
寫在其後。





namespace VendorPackage;

final public static function bar()

{ // method body }} }}

方法及函數呼叫時，方法名稱或函數名稱與參數左括號之間
一定不能
有空格，參數右括號前也
一定不能

有一個空格。

bar();

複製程式碼


參數
可以

---

$foo->bar( $longArgument,

$longerArgument, $muchLongerArgument

複製程式碼

控制結構

控制結構的基本規格如下：

控制結構關鍵字後必須有一個空格。

左括號 ( 後一定不能有空格。

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

右括號 ) 與開始花括號 { 間一定有一個空格。

結構體主體

一定
要有一次縮排。

每個結構體的主體都
必須
被包含在成對的花括號之中，
這能讓結構體更加結構話，以及減少加入新行時，出錯的可能性。

5.1. if 、 elseif 和 else
標準的 if 結構如下程式碼所示，留意 括號、空格以及花括號的位置，
注意 else 和 elseif 都與前面的結束花括號在同一行。

if ($expr1) { // if body} elseif ($expr2) { // elseif body

} else {
// else body;}

複製程式碼

應該使用關鍵字🎜>


應該使用關鍵字🎜>取代所有else if ，以使得所有的控制關鍵字都像是單獨的一個字。

5.2. switch 和 case
標準的 switch 結構如下程式碼所示，留意括號、空格以及花括號的位置。
case 語句
必須
相對 switch 進行一次縮進，而 break 語句以及 case 內的其它語句都 必須 相對 case 進行一次縮排。
如果有非空的 case 直穿語句，主體裡必須有類似 // no break 的註解。





switch ($expr) {
 case 0:

// no break case 2: case 3: case 4: echo🎜> echo Third case, return instead of break'; return; default: echo 'Default case'; break;}複製代碼}複製代碼複製代碼 >5.3. while 和 do while

一個規範的 while 語句應該如下所示，注意其 括號、空格、花括號的位置。

while ($expr) {
 // structure body
}

🎜>

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

do {
 // structure body;

標準的 for 語句如下所示，注意其 括號、空格以及花括號的位置。

}

標準的 foreach 語句如下所示，注意其 括號、空格、花括號的位置。

}

5.6. try, catch
標準的 try catch 語句如下所示，注意其 括號、空格、花括號的位置。





try {