PHP PSR-2 代碼風格規范 (中文版)

jopen 9年前發布 | 46K 次閱讀 PHP規范 PHP開發

本篇規范是 PSR-1 基本代碼規范的繼承與擴展。

本規范希望通過制定一系列規范化PHP代碼的規則，以減少在瀏覽不同作者的代碼時，因代碼風格的不同而造成不便。

當多名程序員在多個項目中合作時，就需要一個共同的編碼規范，
而本文中的風格規范源自于多個不同項目代碼風格的共同特性，
因此，本規范的價值在于我們都遵循這個編碼風格，而不是在于它本身。

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

1. 概覽

代碼必須遵循 PSR-1 中的編碼規范。
</li>
代碼必須使用4個空格符而不是 tab鍵進行縮進。
</li>
每行的字符數應該軟性保持在80個之內，理論上一定不可多于120個，但一定不能有硬性限制。
</li>
每個namespace命名空間聲明語句和use聲明語句塊后面，必須插入一個空白行。
</li>
類的開始花括號({)必須寫在函數聲明后自成一行，結束花括號(})也必須寫在函數主體后自成一行。
</li>
方法的開始花括號({)必須寫在函數聲明后自成一行，結束花括號(})也必須寫在函數主體后自成一行。
</li>
類的屬性和方法必須添加訪問修飾符（private、protected以及public），abstract以及final必須聲明在訪問修飾符之前，而static必須聲明在訪問修飾符之后。
</li>
控制結構的關鍵字后必須要有一個空格符，而調用方法或函數時則一定不能有。
</li>
控制結構的開始花括號({)必須寫在聲明的同一行，而結束花括號(})必須寫在主體后自成一行。
</li>

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

</li> </ul>

1.1. 例子

以下例子程序簡單地展示了以上大部分規范：

update: 因下面程序的<?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
}

}</pre>

2. 通則 

2.1 基本編碼準則 

代碼必須符合 PSR-1 中的所有規范。 

2.2 文件 

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

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

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

2.3. 行 

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

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

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

非空行后一定不能有多余的空格符。 

空行可以使得閱讀代碼更加方便以及有助于代碼的分塊。 

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

2.4. 縮進 

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


備注: 使用空格而不是tab鍵縮進的好處在于，

避免在比較代碼差異、打補丁、重閱代碼以及注釋時產生混淆。

并且，使用空格縮進，讓對齊變得更方便。 
</blockquote>
2.5. 關鍵字 以及 True/False/Null 

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

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

3. namespace 以及 use 聲明 

namespace聲明后 必須 插入一個空白行。 

所有use必須 在namespace后聲明。 

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

use聲明語句塊后 必須 要有一個空白行。 

例如： 

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

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
}</pre>

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
}</pre>

  
4.2. 屬性 

每個屬性都必須添加訪問修飾符。 

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

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

不要使用下劃線作為前綴，來區分屬性是 protected 或 private。 

以下是屬性聲明的一個范例： 

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

4.3. 方法 

所有方法都必須添加訪問修飾符。 

不要使用下劃線作為前綴，來區分方法是 protected 或 private。 

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

一個標準的方法聲明可參照以下范例，留意其括號、逗號、空格以及花括號的位置。 

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

4.4. 方法的參數 

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

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

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

參數列表可以分列成多行，這樣，包括第一個參數在內的每個參數都必須單獨成行。 

拆分成多行的參數列表后，結束括號以及方法開始花括號 必須 寫在同一行，中間用一個空格分隔。 

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

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
}

}</pre>



4.6. 方法及函數調用 

方法及函數調用時，方法名或函數名與參數左括號之間一定不能有空格，參數右括號前也 一定不能有空格。每個參數前一定不能有空格，但其后必須有一個空格。 

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


參數可以分列成多行，此時包括第一個參數在內的每個參數都必須單獨成行。 

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


5. 控制結構 

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


控制結構關鍵詞后必須有一個空格。 

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

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

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

結構體主體一定要有一次縮進。 

結束花括號}一定在結構體主體后單獨成行。 
</ul>
每個結構體的主體都必須被包含在成對的花括號之中，

這能讓結構體更加結構話，以及減少加入新行時，出錯的可能性。 

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進行一次縮進。

如果存在非空的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
};</pre>

參數列表以及變量列表可以分成多行，這樣，包括第一個在內的每個參數或變量都必須單獨成行，而列表的右括號與閉包的開始花括號必須放在同一行。 

以下幾個例子，包含了參數和變量列表被分成多行的多情況。 

<?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
};</pre>



注意，閉包被直接用作函數或方法調用的參數時，以上規則仍然適用。 

<?php
$foo->bar(
    $arg1,
    function ($arg2) use ($var1) {
        // body
    },
    $arg3
);
 


7. 總結 

以上規范難免有疏忽，其中包括但不僅限于： 



全局變量和常量的定義 
</li>

函數的定義 
</li>

操作符和賦值 
</li>

行內對齊 
</li>

注釋和文檔描述塊 
</li>

類名的前綴及后綴 
</li>

最佳實踐 
</li>
</ul>

原文：PizzaLiu github 
來自：http://segmentfault.com/blog/gtg/1190000002521620

本文由用戶 jopen 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。

轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。

本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！

本文地址：http://www.baiduhome.net/lib/view/open1422699781236.html

PHP規范 PHP開發

PHP PSR-2 代碼風格規范 (中文版)

1. 概覽

1.1. 例子

相關經驗

相關資訊

相關文檔

目錄

PHP PSR-2 代碼風格規范 (中文版)

1. 概覽

1.1. 例子

2. 通則

2.1 基本編碼準則

2.2 文件

2.3. 行

2.4. 縮進

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

3. namespace 以及 use 聲明

4. 類、屬性和方法

4.1. 擴展與繼承

4.2. 屬性

4.3. 方法

4.4. 方法的參數

4.5.abstract、final、 以及static

4.6. 方法及函數調用

5. 控制結構

5.1.if、elseif和else

5.2.switch和case

5.3.while和do while

5.4.for

5.5.foreach

5.6.try,catch

6. 閉包

7. 總結

相關經驗

相關資訊

相關文檔

目錄

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

4.5.abstract、final、以及static