PHP 代碼風(fēng)格指南, 遵守 PSR-2 標(biāo)準(zhǔn)編寫的代碼會(huì)顯得非常優(yōu)雅. 別人在閱讀你的代碼的時(shí)候會(huì)賞心悅目.
1: 規(guī)則總覽
- 代碼規(guī)則遵守
PSR-1.- 代碼縮進(jìn)使用
4個(gè)空格. 不是使用tab縮進(jìn).- 一行代碼不要超過(guò)
80個(gè)字符, 超過(guò)的需要設(shè)置換行.namespace聲明語(yǔ)句后需要保留一個(gè)空行. 使用use聲明代碼塊后后面也需要留一個(gè)空行.- 定義
class后的 花括號(hào){和結(jié)束class聲明的}都單獨(dú)使用一行. 不要把{和類名同一行.- 定義
method的時(shí)候, 開始和結(jié)束的花括號(hào){}也都獨(dú)占一行. 和規(guī)則5一樣.abstract,final關(guān)鍵字需要放在可見性聲明前面,static關(guān)鍵字放在可見性聲明后面.- 控制結(jié)構(gòu)中關(guān)鍵字后需要留一個(gè)空格, 函數(shù)調(diào)用是不能留空格.
- 控制結(jié)構(gòu)代碼塊的開始的花括號(hào)
{需要和控制塊開始在同一行. 結(jié)束的花括號(hào)}需要在單獨(dú)一行.- 左括號(hào)(控制開始)后面不要留空格, 右括號(hào)(控制結(jié)束)前不要留空格.
2: 規(guī)則詳解
2.1: 關(guān)于PHP文件
- PHP代碼行結(jié)尾使用 Unix 結(jié)尾符,
\n, Windows 系統(tǒng)使用\r\n作為行結(jié)尾. - 每個(gè)PHP文件后都需要留一行空行.
- 純PHP文件后不需要使用
?>聲明結(jié)束.
2.2: 關(guān)于每行代碼
- 每行代碼不要超過(guò)80個(gè)字符, 超過(guò)了采取多行的編寫方式.
- 如果當(dāng)行代碼已經(jīng)完成功能. 行后面不要留空格.
- 可以適當(dāng)?shù)氖褂每招斜３执a的閱讀性.
- 一行代碼不要完成多個(gè)功能. 每行代碼干一個(gè)步驟.
2.3: 關(guān)于PHP的關(guān)鍵字
- PHP的關(guān)鍵字,
true,false,null使用小寫.
2.4: 關(guān)于 Namespace 和 Use 聲明.
-
namespace聲明后要留一空行. -
use聲明要放在namespace聲明后. -
use聲明每行都要以use開始. -
use聲明塊結(jié)束后要留一空行. - 簡(jiǎn)單的代碼示例:
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
// ... additional PHP code ...
2.5: 關(guān)于類 Classes
- 代碼風(fēng)格適用于
classes,interfaces,traits. - 關(guān)鍵字
extends,implements需要和類名定義在同一行. - 開始
{和}獨(dú)占一行.
<?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比較多. 可以使用多行聲明. 每個(gè)被 implements 的接口都單獨(dú)占一行.
<?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
}
2.6: 關(guān)于類屬性: Properties
- 所有的類屬性都需要帶上
可見性聲明(public,protected,private) 等. - 類屬性名不能使用
var. - 每行不要定義多個(gè)類屬性.
- 不要用什么
_給屬性名做前綴來(lái)區(qū)分是私有屬性或者其他用途.
<?php
namespace Vendor\Package;
class ClassName
{
public $foo = null;
}
2.7: 類方法: Methods
- 所有方法都需要帶
可見性聲明 - 方法名前面不要用統(tǒng)一的前綴來(lái)區(qū)分私有或者受保護(hù)的方法.
- 方法名后不要留空格, 要直接跟對(duì)括號(hào), 方法的花括號(hào)都需要在
獨(dú)立的行. 左對(duì)括號(hào)后不能留空格, 右對(duì)括號(hào)前不要留空格. - 方法中的參數(shù): 參數(shù)后的逗號(hào)
,前不要留空格, 逗號(hào),后面留一個(gè)空格. 帶默認(rèn)值的參數(shù)放到最后.
<?php
namespace Vendor\Package;
class ClassName
{
public function fooBarBaz($arg1, &$arg2, $arg3 = [])
{
// method body
}
}
- 多參數(shù)的時(shí)候需要把參數(shù)分成多行聲明, 每行只放一個(gè)參數(shù), 并且進(jìn)行縮進(jìn). 括號(hào)要另起一行.
<?php
namespace Vendor\Package;
class ClassName
{
public function aVeryLongMethodName(
ClassTypeHint $arg1,
&$arg2,
array $arg3 = []
) {
// method body
}
}
2.8: abstract, final, static
-
abstract,final關(guān)鍵字需要放在可見性聲明前面,static關(guān)鍵字放在可見性聲明后面.
<?php
namespace Vendor\Package;
abstract class ClassName
{
protected static $foo;
abstract protected function zim();
final public static function bar()
{
// method body
}
}
//to be continue.
