PHP 規範之編程規範

時間 2019-11-21

標籤 php 規範編程欄目 PHP 简体版

原文原文鏈接

概述

本規範但願經過制定一系列規範化PHP代碼的規則，以減小在瀏覽不一樣做者的代碼時，因代碼風格的不一樣而形成不便。php

當多名程序員在多個項目中合做時，就須要一個共同的編碼規範，而本文中的風格規範源自於多個不一樣項目代碼風格的共同特性，所以，本規範的價值在於咱們都遵循這個編碼風格，而不是在於它自己。程序員

本文檔的預期讀者PHP開發人員。閉包

本文檔適用於大型商用項目。函數

詳細規範文檔下載：https://mystudy1.oss-cn-shenz...編碼

文檔截圖：spa

文件夾

文件夾名稱必須符合CamelCase式的大寫字母開頭駝峯命名規範。code

文件

PHP代碼文件必須以不帶BOM的 UTF-8 編碼。
純PHP代碼文件必須省略最後的 ?> 結束標籤。

行

行的長度必定限制在140個字符之內。
非空行後必定不能有多餘的空格符。
每行必定不能存在多於一條語句。
適當空行可使得閱讀代碼更加方便以及有助於代碼的分塊（但注意不能濫用空行）。

縮進

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

關鍵字以及 true/false/null

PHP全部關鍵字必須所有小寫。
常量 true、false和 null必須所有小寫。blog

namespace以及use聲明

namespace 聲明後必須插入一個空白行。
全部use必須在namespace 後聲明。
每條use聲明語句必須只有一個use關鍵詞。
use 聲明語句塊後必需要有一個空白行。繼承

例如：

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

類（class），屬性（properties）和方法（methods）

l 這裏的類是廣義的類，它包含全部的類（classes），接口（interface）和traits；

類（class）

l 類的命名必須遵循大寫字母開頭的駝峯式命名規範。

<?php
namespace VendorgiPackage;
class ClassName
{
    // constants, properties, methods
}

extends 和 implements

l 關鍵詞 extends 和 implements必須寫在類名稱的同一行。

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

<?php
namespace VendorgiPackage;
use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackage\BazClass;
class ClassName extends ParentClass implements giArrayAccess, \Countable
{
    // constants, properties, methods
}

l implements的繼承列表若是超出140個字符也能夠分紅多行，這樣的話，每一個繼承接口名稱都必須分開獨立成行，包括第一個。

<?php
namespace VendorgiPackage;
use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackage\BazClass;
class ClassName extends ParentClass implements
    giArrayAccess,
    giCountable,
    giSerializable
{
    // constants, properties, methods
}

常量

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

<?php
namespace VendorgiPackage;
use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackage\BazClass;
class ClassName extends ParentClass implements giArrayAccess, \Countable
{
    const VSESION = '1.0';
    const SITE_URL = 'http://www.xxx.com ';
}

屬性

l 類的屬性命名必須遵循小寫字母開頭的駝峯式命名規範 ($camelCase)。

l 必須對全部屬性設置訪問控制（如，public，protect，private）。

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

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

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

l 定義屬性時先常量屬性再變量屬性，先public 而後 protected，最後private。

如下是屬性聲明的一個範例：

<?php
namespace VendorgiPackage;
class ClassName
{
    const VSESION = '1.0';
public $foo = null;
protected $sex;
private $name;
}

方法

l 方法名稱必須符合 camelCase() 式的小寫字母開頭駝峯命名規範。

l 全部方法都必須設置訪問控制（如，public，protect，private）。

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

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

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

<?php
namespace VendorgiPackage;
class ClassName
{
    public function fooBarBaz($storeName, $storeId, array $info = [])
    {
        // method body
    }
}

方法參數

l 方法參數名稱必須符合 camelCase 式的小寫字母開頭駝峯命名規範

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

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

l 若是參數類型爲對像必須指定參數類型爲具體的類名，以下的$bazObj參數。

l 若是參數類型爲array必須指定參數類型爲array。以下$info。

<?php
namespace VendorgiPackage;
class ClassName
{
    public function foo($storeName, $storeId, BazClass $bazObj, array $info = [])
    {
        // method body
    }
}

l 參數列表超過140個字符能夠分列成多行，這樣，包括第一個參數在內的每一個參數都必須單獨成行。

l 拆分紅多行的參數列表後，結束括號以及最後一個參數必須寫在同一行，其開始花括號必須獨佔一行，結束花括號也必須在方法主體後單獨成一行。

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

abstract 、 final 、以及 static

l 須要添加 abstract 或 final聲明時，必須寫在訪問修飾符前，而 static 則必須寫在其後。

<?php
namespace VendorgiPackage;
abstract class ClassName
{
    protected static $foo;
    abstract protected function zim();
    final public static function bar()
    {
        // method body
    }
}

方法及方法調用

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

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

l 參數列表超過140個字符能夠分列成多行，此時包括第一個參數在內的每一個參數都必須單獨成行。

<?php
$foo->bar(

$longArgument,
$longerArgument,
$muchLongerArgument);

控制結構（control structures）

控制結構的基本規範以下：

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

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

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

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

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

l 結束花括號 } 必定在結構體主體後單獨成行。

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

if、elseif 和 else

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

<?php
if ($expr1) {
    // if body
} elseif ($expr2) {
    // elseif body
} else {
    // else body;
}
// 
單個
if
也必須帶有花括號
if ($expr1) {
    // if body
}

應該使用關鍵詞elseif 代替全部 else if ，以使得全部的控制關鍵字都像是單獨的一個詞。

switch和 case

l 標準的 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;
}

while 和 do while

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

<?php
while ($expr) {

// structure body

}

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

<?php
do {

// structure body;

} while ($expr);

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

<?php
for ($i = 0; $i < 10; $i++) {

// for body

}

foreach

.1.5. foreach
l 標準的 foreach 語句以下所示，注意其括號、空格以及花括號的位置。

<?php
foreach ($iterable as $key => $value) {

// foreach body

}

try catch

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

<?php
try {

// try body

} catch (FirstExceptionType $e) {

// catch body

} catch (OtherExceptionType $e) {

// catch body

}

閉包

l 閉包聲明時，關鍵詞 function 後以及關鍵詞 use 的先後都必需要有一個空格。

l 開始花括號必須寫在聲明的下一行，結束花括號必須緊跟主體結束的下一行。

l 參數列表和變量列表的左括號後以及右括號前，必須不能有空格。

l 參數和變量列表中，逗號前必須不能有空格，而逗號後必需要有空格。

l 閉包中有默認值的參數必須放到列表的後面。

l 標準的閉包聲明語句以下所示，注意其括號、逗號、空格以及花括號的位置。

<?php
$closureWithArgs = function ($arg1, $arg2) 
{
    // body
};
$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) 
{
    // body
};

參數列表以及變量列表能夠分紅多行，這樣，包括第一個在內的每一個參數或變量都必須單獨成行。

如下幾個例子，包含了參數和變量列表被分紅多行的多狀況。

<?php
$longArgsNoVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument)
{
   // body
};
$noArgsLongVars = function () use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3) 
{
   // body
};
$longArgsLongVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3) 
{
   // body
};
$longArgsShortVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use ($var1) 
{
   // body
};
$shortArgsLongVars = function ($arg) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) 
{
   // body
};

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

<?php
$foo->bar(

$arg1,
function ($arg2) use ($var1) 
{
    // body
},
$arg3);

註釋

文件註釋
l 註釋開始 / 不能夠 /，結束 / 不能夠 /。

l 第二行php版本信息，版本信息後一空行。

l 註解內容對齊，註解之間不可有空行。

l 星號和註釋內容中間必須是一個空格。

l 保持註解順序一致@copyright而後　@ link　再　@ license。

類註釋
l 註釋開始 / 不能夠 /，結束/ 不能夠 /。

l 第二行開始描述，描述後一空行。

l 註解內容對齊，註解之間不可有空行。

l 星號和註釋內容中間必須是一個空格。

l 保持註解順序一致@author而後@since再@version。

屬性註釋
l 註釋開始 / 不能夠 /，結束/ 不能夠 /。

l 星號和註釋內容中間必須是一個空格。

l 使用var註解並註明類型。

l 註解基本類型包括int、sting、array、boolea、具體類名稱。

方法註釋
l 註釋開始 / 不能夠 /，結束/ 不能夠 /。

l 第二行開始方法描述，方法描述後一空行。

l 註解內容對齊，註解之間不可有空行。

l 星號和註釋內容中間必須是一個空格。

l 註解順序爲@param，@return，@author和@since，參數的順序必須與方法參數順序一致。

l 參數和返回值註解包括基本類型（int sting array boolean和unknown）和對象，若是多個可能類型使用|分割。

l 若是參數類型爲對像必須指定參數類型爲具體的類名，以下的$arg1參數。

l 若是參數類型爲array必須指定參數類型爲array。以下$arg2。

l 須要做者和日期註解，日期爲最後修改日期。

其餘註釋
l 代碼註釋儘可能使用 //

l 註釋內容開始前必須一個空格

l 代碼行尾註釋//前面必須一個空格

l 代碼註釋與下面的代碼對齊

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。

PHP 規範之編程規範

概述

文件夾

文件

行

縮進

關鍵字以及 true/false/null

namespace以及use聲明

類（class），屬性（properties）和方法（methods）

類（class）

extends 和 implements

常量

屬性

方法

方法參數

abstract 、 final 、 以及 static

方法及方法調用

控制結構（control structures）

if、elseif 和 else

switch和 case

while 和 do while

foreach

try catch

閉包

註釋

abstract 、 final 、以及 static