PSR 是 PHP 標準推薦,旨在提高PHP編程規范并統一PHP代碼的風格以便更好的閱讀和維護。在這里我們將會介紹PHP編程規范中的所有內容,讓你了解如何編寫清晰、易讀、可維護的PHP代碼。
命名空間
使用
命名空間
使用
namespace
來定義命名空間。如果你的程序中沒有返回東西,你可以把namespace
一起寫在之后。php
<?php
namespace My\Name\Space;
類、屬性和方法
類名使用StudlyCaps
命名規范,且每個命名空間首字母大寫。屬性和方法名都需要使用camelCase
命名規范。php
<?php
namespace My\Name\Space;
<br>
class MyClass
{
public function doSomething()
{
// code...
}
<br>
protected $string;
}
常量、函數和變量
常量名應該使用大寫字母和下劃線分隔符。函數和變量名都需要使用camelCase
命名規范。php
<?php
namespace My\Name\Space;
<br>
const MY_BIRTHDAY = '1992-01-01';
<br>
function checkPassword($password)
{
// code...
}
<br>
$myName = 'John Doe';
控制流
控制流語句(例如if
、else
、while
、switch
等)必須使用花括號。這有助于防止代碼錯誤和閱讀性更好。php
<?php
namespace My\Name\Space;
<br>
if ($expr1) {
// code...
} elseif ($expr2) {
// code...
} else {
// code...
};
<br>
while ($expr) {
// code...
};
<br>
switch ($expr) {
case 0:
// code...
break;
case 1:
// code...
break;
default:
// code...
break;
};
注釋
注釋應該清晰、簡短、易懂,并且應該使用 DocBlock 形式。php
<?php
namespace My\Name\Space;
<br>
/**
* Short description.
*
* Long description (empty line between).
*
* @param type $var
* @param type $var optional description
*
* @return type
**/
function myFunction($var, $another = '')
{
// code...
};
代碼風格
代碼必須使用合適的縮進,使用 4 個空格作為一個縮進的標準。每行代碼長度不得超過 80 個字節,如果代碼過長,應該按照合適的方式換行。php
<?php
namespace My\Name\Space;
<br>
class MyClass
{
public function myMethod()
{
if ($expression1 && $expression2) {
// code...
}
<br>
if ($expression3 || $expression4) {
// code...
}
<br>
$string = 'This is a very, very, very, very long string that is over 80 characters';
<br>
$string = 'This is a long string that is broken up into two lines
for readability.';
}
}
結尾
PHP 文件必須以不帶 BOM 的UTF-8
編碼結束。結尾標簽?>
應該省略,以避免誤解和空格等問題。php
<?php
namespace My\Name\Space;
<br>
class MyClass
{
// code...
}
總結
PSR 幫助開發者編寫出規范、易讀、可維護的PHP代碼。一個程序員需要熟悉并應用所有的標準來使代碼更加清晰并降低維護成本。讓我們努力遵循這些標準,使得我們的公共代碼庫更加易于閱讀和使用。
上一篇css導航欄首頁模塊
下一篇css導航固定在底部