97se亚洲国产综合自在线观看,扒开腿让我添个痛快,伴郎粗大的内捧猛烈进出视频观看

首頁

後端開發(fā)

php教程

PHP PSR-2 程式碼風(fēng)格規(guī)範(fàn)

WBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWB

Jul 23, 2016 am 08:54 AM

程式碼風(fēng)格規(guī)範(fàn)

本篇規(guī)範(fàn)是 [PSR-1][] 基本程式碼規(guī)範(fàn)的繼承與擴(kuò)充。

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

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

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

概覽

代碼必須遵循 [PSR-1][] 中的編碼規(guī)範(fàn) 。

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

每行的字元數(shù)應(yīng)該軟性保持在80個之內(nèi)，理論上一定不可多於120個，但一定不能有硬性限制。

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

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

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

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

控制結(jié)構(gòu)的關(guān)鍵字後必須要有一個空格符，而呼叫方法或函數(shù)時則一定不能有。

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

控制結(jié)構(gòu)的開始左括號後和結(jié)束右括號前，都一定不能有空格符。

1.1. 例子

以下範(fàn)例程式簡單地展示了上述大部分規(guī)格：

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 基本編碼準(zhǔn)則

代碼必須符合 [PSR-1][] 中的所有規(guī)範(fàn)。

2.2 文件

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

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

純PHP程式碼檔案必須省略最後的 ?> 結(jié)束標(biāo)籤。

2.3. 行

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

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

每行不應(yīng)該多於80個字符，大於80字符的行應(yīng)該折成多行。

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

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

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

2.4. 縮排

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

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

2.5. 關(guān)鍵字以及 True/False/Null

PHP所有 [關(guān)鍵字][]必須全部小寫。

常數(shù) true 、false 和 null 也必須全部小寫。

namespace 以及 use 聲明

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

所有 use 必須在 namespace 後聲明。

每個 use 宣告語句必須只有一個 use 關(guān)鍵字。

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

例如：

namespace VendorPackage;
use FooClass;
use BarClass as
use FooClass;
use BarClass as as

// ... additional PHP code ...

複製程式碼

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

關(guān)鍵字 extends 和 implements

必須

寫在類別名稱的同一行。

類別的開始花括號
必須
獨佔一行，結(jié)束花括號也
必須
在類主體後面獨佔一行。
namespace VendorPackage;

use FooClass;use BarClass as Bar；use FooClass;

OClass as Barsa>

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

複製程式碼

}

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

use BarClass as Bar；

use FooClass;OClass as Barsa> class ClassName extends ParentClass implements

ArrayAccess,

Countable, Serializable{

// constants, properties, methods

{ // constants, properties, methods{

// constants, properties, methods

} // constants, properties, methods}

// constants, properties, methods

} // constants, pro>代碼

4.2. 屬性

每個屬性都

必須

新增存取修飾符。

一定不可
使用關(guān)鍵字 var 宣告一個屬性。
每個語句
一定不可
定義超過一個屬性。

不要使用底線作為前綴，來區(qū)分屬性是 protected 或 private。

以下是屬性宣告的範(fàn)例：

namespace VendorPackage;

class ClassName

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

所有方法都

必須

新增存取修飾符。

使用底線作為前綴，來區(qū)分方法是 protected 或 private。
方法名稱後
一定不能
有空格符，其開始花括號
必須
獨佔一行，結(jié)束花括號也
必須
在方法主體後單獨成一行。參數(shù)左括號後面和右括號前
一定不能

有空格。

一個標(biāo)準(zhǔn)的方法宣告可參考以下範(fàn)例，留意其括號、逗號、空格以及花括號的位置。 namespace VendorPackage;class ClassName{ public function fooooBarBaz($arg1 $arg3 = []) { // method body }}複製程式碼

4.4. 方法的參數(shù)

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

有預(yù)設(shè)值的參數(shù)，必須放到參數(shù)清單的末端。

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

拆分成多行的參數(shù)清單後，結(jié)束括號以及方法開始花括號必須寫在同一行，中間用一個空格分隔。

namespace VendorPackage;class ClassName{

public function aVery??L類, ClassfVer

&$arg2,

array $arg3 = []

) {

// method body

}
複製程式碼
}
複製程式碼
}
複製程式碼
}

複製程式碼}

複製程式碼}

複製程式碼

}

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

abstract class ClassName

{ protected static; > abstract protected function zim();

final public static function bar()

{ // method body }} }}

程式碼

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

有空格。每個參數(shù)前

一定不能有空格，但其後必須

有一個空格。

bar();

$foo->bar($arg1);

Foo::bar($arg2, $ arg3);

複製程式碼
參數(shù)
可以

分列成多行，此時包括第一個參數(shù)在內(nèi)的每個參數(shù)都

必須單獨成行。

$foo->bar( $longArgument,

$longerArgument, $muchLongerArgument

複製程式碼

控制結(jié)構(gòu)

控制結(jié)構(gòu)的基本規(guī)格如下：

控制結(jié)構(gòu)關(guān)鍵字後必須有一個空格。

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

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

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

結(jié)構(gòu)體主體

一定
要有一次縮排。

結(jié)束花括號 }

一定

每個結(jié)構(gòu)體的主體都
必須
被包含在成對的花括號之中，
這能讓結(jié)構(gòu)體更加結(jié)構(gòu)話，以及減少加入新行時，出錯的可能性。
5.1. if 、 elseif 和 else
標(biāo)準(zhǔn)的 if 結(jié)構(gòu)如下程式碼所示，留意括號、空格以及花括號的位置，
注意 else 和 elseif 都與前面的結(jié)束花括號在同一行。

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

} else {
// else body;}

複製程式碼

應(yīng)該使用關(guān)鍵字??>
應(yīng)該使用關(guān)鍵字??>取代所有else if ，以使得所有的控制關(guān)鍵字都像是單獨的一個字。
5.2. switch 和 case
標(biāo)準(zhǔn)的 switch 結(jié)構(gòu)如下程式碼所示，留意括號、空格以及花括號的位置。
case 語句
必須
相對 switch 進(jìn)行一次縮進(jìn)，而 break 語句以及 case 內(nèi)的其它語句都必須相對 case 進(jìn)行一次縮排。
如果有非空的 case 直穿語句，主體裡必須有類似 // no break 的註解。
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??> echo Third case, return instead of break'; return; default: echo 'Default case'; break;}複製代碼}複製代碼複製代碼 >5.3. while 和 do while

一個規(guī)範(fàn)的 while 語句應(yīng)該如下所示，注意其括號、空格、花括號的位置。

while ($expr) {
// structure body
}

複製程式碼複製程式碼

??>

標(biāo)準(zhǔn)的do while 語句如下所示，同樣的，注意其括號、空格以及花括號的位置。

do {
// structure body;

} while ($expr);

複製程式碼

標(biāo)準(zhǔn)的 for 語句如下所示，注意其括號、空格以及花括號的位置。

for ($i = 0; $i // for body

}

複製程式碼

標(biāo)準(zhǔn)的 foreach 語句如下所示，注意其括號、空格、花括號的位置。

foreach ($iterable as $key => $value) { // foreach body

}

複製程式碼

5.6. try, catch
標(biāo)準(zhǔn)的 try catch 語句如下所示，注意其括號、空格、花括號的位置。
try {

// try body

} catch (FirstExceptionType $e) { // catch body // catch body} catch (OtherExceptionType $e) {
// catch body
}

複製程式碼

閉包 閉包聲明時，關(guān)鍵字 function 後以及關(guān)鍵字 use 的前後都必須
要有一個空格。
開始花括號必須
寫在聲明的同一行，結(jié)束花括號
必須緊跟主體結(jié)束的下一行。 參數(shù)列表和變數(shù)列表的左括號後面以及右括號前，必須不能
有空格。
參數(shù)和變數(shù)清單中，逗號前必須不能
有空格，而逗號後
必須
要有空格。

閉包中有預(yù)設(shè)值的參數(shù)
必須
放到清單的後面。

標(biāo)準(zhǔn)的閉包聲明語句如下所示，注意其括號、逗號、空格、花括號的位置。

$closureWithArgs = function ($arg1, $arg2) {

// body};

$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) { // body};複製代碼

參數(shù)列表以及變數(shù)列表
可以
分成多行，這樣，包括第一個在內(nèi)的每個參數(shù)或變數(shù)都
必須
單獨成行，而列表的右括號與閉包的開始花括號
必須

放在同一行。

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

$longArgs_noVars = function (

$longArgument,

$longerArgument,

$longArgument,

$longerArgument,

$longArgument,

$longerArgument, // body

};

$noArgs_longVars = function () use (

$longVar1,

$longerVar2,

$muchLongerVar3

$longerVar2,

$muchLongerVar3

//

body

};

$longArgs_longVars = function (

$longArgument,

$longerArgument,

$muchLongerArgument

) long. longerVar2,

$muchLongerVar3

) {

// body

};

$longArgs_shortVars = function (

$longArgument, $ muchLongerArgument
) use ($var1) {

// body

};

$shortArgs_longVars = function ($arg) use (
$longVar1, $muchLongerVar3) {
// body
};

複製程式碼

注意，閉包直接用作函數(shù)或方法呼叫的參數(shù)時，以上規(guī)則仍然適用。

$foo->bar(

$arg1,
function ($arg2) use ($var1) { // body },
$arg3);複製程式碼
總結(jié)

以上規(guī)範(fàn)難免有疏忽，其中包括但不限於：

全域變數(shù)與常數(shù)的定義

函數(shù)的定義

操作符與賦值

行內(nèi)對齊

註解與文件描述區(qū)塊

類別名稱的前綴及後綴

最佳實踐

本規(guī)範(fàn)之後的修訂與擴(kuò)展將彌補(bǔ)以上不足。
附錄 A. 問卷調(diào)查
為了編寫本規(guī)範(fàn)，小組制定了問卷，用來統(tǒng)計各成員項目的共同規(guī)範(fàn)。
以下是此問卷調(diào)查的數(shù)據(jù)，在此供查閱。
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:-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_tyWnmEvo??swKBtSc0tKkZmJA,http://www.chisimba.com,n/a,https://github.com/Rex/j/mill/Respec??ky/5,https://github.com/Respec??ky/5. 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,1200,?,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,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

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

複製程式碼
A.2. 問卷說明
indent_type:
縮排型. tab = "使用 tab 鍵一次", 2 or 4 = "空格的數(shù)量"

line_length_limit_soft:
每行字元數(shù)量的「軟」限制. ? = 不可辯護(hù)或無回應(yīng), no 表示無限制.

line_length_limit_hard:
每行字元數(shù)量的「硬」限制. ? = 不可辯護(hù)或無作答, no 表示無限制.

class_names:
類別名稱的命名. lower = 只允許小寫字母, lower_under = 下滑線分隔的小寫字母, studly = StudlyCase 的駝峰風(fēng)格.

class_brace_line:
類別的開始花括號是與 class 關(guān)鍵字在同一行或是在其的下一行？

constant_names:
類別的常數(shù)如何命名? upper = 底線分隔的大寫字母.

true_false_null:
關(guān)鍵字 true、false 以及 null 是全部小寫 lower 還是全部大寫 upper?

method_names:
方法名稱如何命名? camel = camelCase, lower_under = 下劃線分隔的小寫字母.

method_brace_line:
方法的開始花括號是與方法名稱在同一行還是在其的下一行？

control_brace_line:
控制結(jié)構(gòu)的開始花括號是與宣告在同一行還是在其的下一行？

control_space_after:
控制結(jié)構(gòu)關(guān)鍵字後是否有空格？

always_use_control_braces:
控制結(jié)構(gòu)體是否都要包含在花括號內(nèi)？

else_elseif_line:
else 或 elseif 與前面的結(jié)束花括號在同一行還是在其的下一行？

case_break_indent_from_switch:
switch 語句中的 case 與 break 需要相對 switch 縮排幾次？

function_space_after:
函數(shù)呼叫語句中，函數(shù)名稱與變數(shù)清單的左括號之間是否有空格？

closing_php_tag_required:
純 PHP 程式碼的文件，是否需要 ?> 結(jié)束標(biāo)籤？

line_endings:
選擇哪一種類型的行結(jié)束符號？

static_or_visibility_first:
宣告一個靜態(tài)方法時，static 是寫存取修飾符前還是後？

control_space_parens:
控制結(jié)構(gòu)裡，左括號後面、右括號前是否有空格？ yes = if ( $expr ), no = if ($expr).

blank_line_after_php:
PHP 開始標(biāo)籤後，是否需要一個空白行？

class_method_control_brace:
開始花括號在類別、方法和控制結(jié)構(gòu)的位置統(tǒng)計。
A.3. 問卷統(tǒng)計結(jié)果

indent_type:

tab: 7

2: 1

4: 14

line_length_limit_soft: ??

no: 3

75: 4

80: 6

85: 1

100: 1

120: 4

150: 1

120: 4

150: 1 ?: 2
no: 11

85: 4

100: 3

120: 2

class_names:

?: 1

lower: 1 studly: 19
class_brace_line:

下一個: 19

class_brace_line:

next: 16

same: 6

constant_names:

upper: 22

truestant_names:

upper: 22

true_false_null: ?? 3

method_names:

camel: 21

lower_under: 1

method_brace_line:

next: 15

same: 7

control_bm> same: 7

control_bee> : 18

control_space_after:

no: 2

yes: 20

always_use_control_braces:

no: 3

yes: 19 ext.> s 3:19 3: 19 3: 19case_break_indent_from_switch:
0/1: 4

1/1: 4

1/2: 14

function_space_after:function_space_after: no: 19
yes: 3

line_endings:

?: 5

LF: 17

static_or_visibility_first:

?: 5

either: 7 visibility: 6
control_space_parens:

?: 1

no: 19

yes: 2

blank_line_after_php:

?????> ? : 8

class_method_control_brace:

next/next/next: 4

next/next/same: 11

next/same/same: 1

same/same/ame: 60

複製程式碼

轉(zhuǎn)自Github(PizzaLiu)

PHP, PSR