摘要：概述本規(guī)范希望通過(guò)制定一系列規(guī)范化代碼的規(guī)則，以減少在瀏覽不同作者的代碼時(shí)，因代碼風(fēng)格的不同而造成不便。結(jié)構(gòu)體主體一定要有一次縮進(jìn)。每個(gè)結(jié)構(gòu)體的主體都必須被包含在成對(duì)的花括號(hào)之中，這能讓結(jié)構(gòu)體更加標(biāo)準(zhǔn)，以及減少加入新行時(shí)，引入出錯(cuò)的可能性。

本規(guī)范希望通過(guò)制定一系列規(guī)范化PHP代碼的規(guī)則，以減少在瀏覽不同作者的代碼時(shí)，因代碼風(fēng)格的不同而造成不便。

當(dāng)多名程序員在多個(gè)項(xiàng)目中合作時(shí)，就需要一個(gè)共同的編碼規(guī)范， 而本文中的風(fēng)格規(guī)范源自于多個(gè)不同項(xiàng)目代碼風(fēng)格的共同特性， 因此，本規(guī)范的價(jià)值在于我們都遵循這個(gè)編碼風(fēng)格，而不是在于它本身。

本文檔的預(yù)期讀者PHP開(kāi)發(fā)人員。

本文檔適用于大型商用項(xiàng)目。

詳細(xì)規(guī)范文檔下載：https://mystudy1.oss-cn-shenz...

文檔截圖：

文件夾名稱必須符合CamelCase式的大寫字母開(kāi)頭駝峰命名規(guī)范。

PHP代碼文件必須以不帶BOM的 UTF-8 編碼。

純PHP代碼文件必須省略最后的 ?> 結(jié)束標(biāo)簽。

行的長(zhǎng)度一定限制在140個(gè)字符以內(nèi)。

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

每行一定不能存在多于一條語(yǔ)句。

適當(dāng)空行可以使得閱讀代碼更加方便以及有助于代碼的分塊（但注意不能濫用空行）。

代碼必須使用4個(gè)空格符的縮進(jìn)，一定不能用 tab鍵 。

PHP所有關(guān)鍵字必須全部小寫。
常量 true、false和 null必須全部小寫。

namespace 聲明后必須插入一個(gè)空白行。
所有use必須在namespace 后聲明。
每條use聲明語(yǔ)句必須只有一個(gè)use關(guān)鍵詞。
use 聲明語(yǔ)句塊后必須要有一個(gè)空白行。

例如：

namespace VendorgiPackage;
use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackageBazClass;
// ... additional PHP code ...

l 這里的類是廣義的類，它包含所有的類（classes），接口（interface）和traits；

l 類的命名必須遵循大寫字母開(kāi)頭的駝峰式命名規(guī)范 。

extends 和 implements
l   關(guān)鍵詞 extends 和 implements必須寫在類名稱的同一行。
l   類的開(kāi)始花括號(hào)必須獨(dú)占一行，結(jié)束花括號(hào)也必須在類主體后獨(dú)占一行。

l   implements的繼承列表如果超出140個(gè)字符也可以分成多行，這樣的話，每個(gè)繼承接口名稱都必須分開(kāi)獨(dú)立成行，包括第一個(gè)。

常量
l   類的常量中所有字母都必須大寫，詞間以下劃線分隔。參照以下代碼：

屬性
l   類的屬性命名必須遵循小寫字母開(kāi)頭的駝峰式命名規(guī)范 ($camelCase)。
l   必須對(duì)所有屬性設(shè)置訪問(wèn)控制（如，public，protect，private）。
l   一定不可使用關(guān)鍵字 var 聲明一個(gè)屬性。
l   每條語(yǔ)句一定不可定義超過(guò)一個(gè)屬性。
l   不要使用下劃線作為前綴，來(lái)區(qū)分屬性是 protected 或 private。
l   定義屬性時(shí)先常量屬性再變量屬性，先public 然后 protected，最后private。
以下是屬性聲明的一個(gè)范例：

方法
l   方法名稱必須符合 camelCase() 式的小寫字母開(kāi)頭駝峰命名規(guī)范。
l   所有方法都必須設(shè)置訪問(wèn)控制（如，public，protect，private）。
l   不要使用下劃線作為前綴，來(lái)區(qū)分方法是 protected 或 private。
l   方法名稱后一定不能有空格符，其開(kāi)始花括號(hào)必須獨(dú)占一行，結(jié)束花括號(hào)也必須在方法主體后多帶帶成一行。參數(shù)左括號(hào)后和右括號(hào)前一定不能有空格。
一個(gè)標(biāo)準(zhǔn)的方法聲明可參照以下范例，留意其括號(hào)、逗號(hào)、空格以及花括號(hào)的位置。

方法參數(shù)
l   方法參數(shù)名稱必須符合 camelCase 式的小寫字母開(kāi)頭駝峰命名規(guī)范
l   參數(shù)列表中，每個(gè)參數(shù)后面必須要有一個(gè)空格，而前面一定不能有空格。
l   有默認(rèn)值的參數(shù)，必須放到參數(shù)列表的末尾。
l   如果參數(shù)類型為對(duì)像必須指定參數(shù)類型為具體的類名，如下的$bazObj參數(shù)。
l   如果參數(shù)類型為array必須指定參數(shù)類型為array。如下$info。

l   參數(shù)列表超過(guò)140個(gè)字符可以分列成多行，這樣，包括第一個(gè)參數(shù)在內(nèi)的每個(gè)參數(shù)都必須多帶帶成行。
l   拆分成多行的參數(shù)列表后，結(jié)束括號(hào)以及最后一個(gè)參數(shù) 必須 寫在同一行，其開(kāi)始花括號(hào)必須獨(dú)占一行，結(jié)束花括號(hào)也必須在方法主體后多帶帶成一行。

abstract 、 final 、 以及 static
l   需要添加 abstract 或 final聲明時(shí)， 必須寫在訪問(wèn)修飾符前，而 static 則必須寫在其后。

方法及方法調(diào)用
l   方法及方法調(diào)用時(shí)，方法名與參數(shù)左括號(hào)之間一定不能有空格，參數(shù)右括號(hào)前也一定不能有空格。每個(gè)參數(shù)前一定不能有空格，但其后必須有一個(gè)空格。
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);
l   參數(shù)列表超過(guò)140個(gè)字符可以分列成多行，此時(shí)包括第一個(gè)參數(shù)在內(nèi)的每個(gè)參數(shù)都必須多帶帶成行。
$foo->bar(
$longArgument,
$longerArgument,
$muchLongerArgument);



控制結(jié)構(gòu)（control structures）
控制結(jié)構(gòu)的基本規(guī)范如下：
l  控制結(jié)構(gòu)關(guān)鍵詞后必須有一個(gè)空格。
l  左括號(hào) ( 后一定不能有空格。
l  右括號(hào) ) 前也一定不能有空格。
l  右括號(hào) ) 與開(kāi)始花括號(hào) { 間一定有一個(gè)空格。
l  結(jié)構(gòu)體主體一定要有一次縮進(jìn)。
l  結(jié)束花括號(hào) } 一定在結(jié)構(gòu)體主體后多帶帶成行。
l  每個(gè)結(jié)構(gòu)體的主體都必須被包含在成對(duì)的花括號(hào)之中， 這能讓結(jié)構(gòu)體更加標(biāo)準(zhǔn)，以及減少加入新行時(shí)，引入出錯(cuò)的可能性。
if、elseif 和 else
l  標(biāo)準(zhǔn)的 if 結(jié)構(gòu)如下代碼所示，留意 括號(hào)、空格以及花括號(hào)的位置， 注意 else 和 elseif 都與前面的結(jié)束花括號(hào)在同一行。

應(yīng)該使用關(guān)鍵詞elseif 代替所有 else if ，以使得所有的控制關(guān)鍵字都像是多帶帶的一個(gè)詞。
switch和 case
l  標(biāo)準(zhǔn)的 switch 結(jié)構(gòu)如下代碼所示，留意括號(hào)、空格以及花括號(hào)的位置。 case 語(yǔ)句必須相對(duì)switch 進(jìn)行一次縮進(jìn)，而 break 語(yǔ)句以及 case 內(nèi)的其它語(yǔ)句都 必須相對(duì) case 進(jìn)行一次縮進(jìn)。 如果存在非空的 case 直穿語(yǔ)句，主體里必須有類似 // no break 的注釋。

while 和 do while
l  一個(gè)規(guī)范的 while 語(yǔ)句應(yīng)該如下所示，注意其 括號(hào)、空格以及花括號(hào)的位置。
while ($expr) {
// structure body
}
l  標(biāo)準(zhǔn)的 do while 語(yǔ)句如下所示，同樣的，注意其 括號(hào)、空格以及花括號(hào)的位置。
do {
// structure body;
} while ($expr);
for
l  標(biāo)準(zhǔn)的 for 語(yǔ)句如下所示，注意其括號(hào)、空格以及花括號(hào)的位置。
for ($i = 0; $i < 10; $i++) {
// for body
}
foreach
.1.5.     foreach
l  標(biāo)準(zhǔn)的 foreach 語(yǔ)句如下所示，注意其括號(hào)、空格以及花括號(hào)的位置。
foreach ($iterable as $key => $value) {
// foreach body
}
try catch
l  標(biāo)準(zhǔn)的 try catch 語(yǔ)句如下所示，注意其括號(hào)、空格以及花括號(hào)的位置。
try {
// try body
} catch (FirstExceptionType $e) {
// catch body
} catch (OtherExceptionType $e) {
// catch body
}
閉包
l  閉包聲明時(shí)，關(guān)鍵詞 function 后以及關(guān)鍵詞 use 的前后都必須要有一個(gè)空格。
l  開(kāi)始花括號(hào)必須寫在聲明的下一行，結(jié)束花括號(hào)必須緊跟主體結(jié)束的下一行。
l  參數(shù)列表和變量列表的左括號(hào)后以及右括號(hào)前，必須不能有空格。
l  參數(shù)和變量列表中，逗號(hào)前必須不能有空格，而逗號(hào)后必須要有空格。
l  閉包中有默認(rèn)值的參數(shù)必須放到列表的后面。
l  標(biāo)準(zhǔn)的閉包聲明語(yǔ)句如下所示，注意其 括號(hào)、逗號(hào)、空格以及花括號(hào)的位置。

參數(shù)列表以及變量列表可以分成多行，這樣，包括第一個(gè)在內(nèi)的每個(gè)參數(shù)或變量都必須多帶帶成行。
以下幾個(gè)例子，包含了參數(shù)和變量列表被分成多行的多情況。

注意，閉包被直接用作函數(shù)或方法調(diào)用的參數(shù)時(shí)，以上規(guī)則仍然適用。
$foo->bar(
$arg1,
function ($arg2) use ($var1) 
{
    // body
},
$arg3);


注釋
文件注釋
l  注釋開(kāi)始 / 不可以 /，結(jié)束 / 不可以 /。
l  第二行php版本信息，版本信息后一空行。
l  注解內(nèi)容對(duì)齊，注解之間不可有空行。
l  星號(hào)和注釋內(nèi)容中間必須是一個(gè)空格。
l  保持注解順序一致@copyright然后　@ link　再　@ license。
類注釋
l  注釋開(kāi)始 / 不可以 /，結(jié)束/ 不可以 /。
l  第二行開(kāi)始描述，描述后一空行。
l  注解內(nèi)容對(duì)齊，注解之間不可有空行。
l  星號(hào)和注釋內(nèi)容中間必須是一個(gè)空格。
l  保持注解順序一致@author然后@since再@version。
屬性注釋
l  注釋開(kāi)始 / 不可以 /，結(jié)束/ 不可以 /。
l  星號(hào)和注釋內(nèi)容中間必須是一個(gè)空格。
l  使用var注解并注明類型。
l  注解基本類型包括int、sting、array、boolea、具體類名稱。
方法注釋
l 注釋開(kāi)始 / 不可以 /，結(jié)束/ 不可以 /。
l 第二行開(kāi)始方法描述，方法描述后一空行。
l 注解內(nèi)容對(duì)齊，注解之間不可有空行。
l 星號(hào)和注釋內(nèi)容中間必須是一個(gè)空格。
l 注解順序?yàn)锧param，@return，@author和@since，參數(shù)的順序必須與方法參數(shù)順序一致。
l 參數(shù)和返回值注解包括基本類型（int sting array boolean和unknown）和對(duì)象，如果多個(gè)可能類型使用|分割。
l 如果參數(shù)類型為對(duì)像必須指定參數(shù)類型為具體的類名，如下的$arg1參數(shù)。
l 如果參數(shù)類型為array必須指定參數(shù)類型為array。如下$arg2。
l 需要作者和日期注解，日期為最后修改日期。
其他注釋
l 代碼注釋盡量使用 //
l 注釋內(nèi)容開(kāi)始前必須一個(gè)空格
l 代碼行尾注釋//前面必須一個(gè)空格
l 代碼注釋與下面的代碼對(duì)齊