首頁  >  文章  >  後端開發  >  PHP程式設計風格規格詳細介紹

PHP程式設計風格規格詳細介紹

angryTom
angryTom轉載
2019-08-09 16:44:323055瀏覽

PHP程式設計風格規格詳細介紹

  由於PHP的靈活性,很多人寫起程式碼來也不講求一個好的程式碼規範,使得本來就靈活的PHP程式碼看起來很亂,其實PSR規範中的PSR-1和PSR-2已經定義了PHP編碼中的一些規範,只要我們好好遵守這些規範,即使是使用彈性的腳本語言,也能寫出非常漂亮工整的程式碼。首先我們來看一下已經通過的PSR規範,然後大致講解PSR-1和PSR-2規範的一些具體要求。

已通過的PSR

#PSR編號 #說明
1 基礎編碼規格 關於PHP標籤和基本命名約定等基礎的規格
2 編碼風格規格 關於大括號的位置和參數清單等編碼格式的規定
3 日誌介面規格 關於日誌等級以及記錄日誌的行為的規定
4 自動載入規格 關於類別和命名空間的命名約定,以及它們與檔案系統間映射的規定
#6 快取介面規範 關於快取管理的規定,其中包括資料類型、快取項目的生存週期、錯誤處理等
#7 HTTP訊息介面規格 #關於HTTP請求和回應的約定

PSR-1基礎編碼規格

#1、開閉標籤

  首先,PHP程式碼必須以63f6a095c55eff3802bf706354993249標籤結束,而應該以一個空白行結束。

2、namespace宣告後面應該插入一個空白行,use宣告語句區塊後面也應該要有一個空白行

  不要在同一行程式碼中進行多次use宣告。

3、類別的開始和結束

  class關鍵字、類別名,以及extends和implements關鍵字必須在同一行。如果一個類別實作了多個接口,那麼這些接口名可以在類別聲明的同一行中,也可以各佔一行。如果選擇將這些介面名稱放在多行中,那麼第一個介面名稱必須自成一行,而不是跟在implements關鍵字後面。類別的開始花括號({)應該寫在函數宣告後自成一行,結束花括號(})也應該寫在類別後面自成一行。也就是說,類別宣告看起來如下所示

class EarthGame extends Game implements
    Playable,    
    Savable
{ 
       //类体
}

  也可以將類別名稱與類別宣告放在同一行中。

class EarthGame extends Game implements Playble, Savable
{ 
    //类体
 }

4、屬性宣告

  每個屬性都必須有存取修飾符(public、private或protected)。不行使用關鍵字var聲明屬性。 PSR-1中已經涵蓋了屬性名的規格:可以使用底線、小寫駝峰式命名或大寫駝峰式命名方式,但應該保持一致。 (個人推薦屬性採用小寫式駝峰)

5、方法的開始和結束

  所有方法必須具有存取修飾符(public、private或protected)。存取修飾符必須在abstract或final之後,static之前。具有預設值得方法參數應該放在參數列表的末端。

  ●單行宣告
    方法的開始花括號({)應該寫在方法名稱後自成一行,結束花括號(})也應該寫在方法體後自成一行(直接跟在方法代碼之後)。方法參數清單不應該以空格開始或結束(即應該緊貼包裹著它們的圓括號)。對於每個參數,參數名稱(或預設值)後面應該有一個逗號,且逗號後面有一個空格。這聽起來似乎有些複雜,如下所示:

final public static function generateTile(int $diamondCount, bool $polluted = false)
{
   //方法体
}

  ●多行宣告
    如果方法有很多參數,那麼單行方法宣告是不實際的。此時我們可以分割參數列表,以便將每個參數(包括類型、參數變數、預設值和逗號)單獨放在縮排的一行中。這種情況下,結束圓括號應該放在參數清單後面一行中,並與方法宣告的起始位置對齊。開始花括號({)應該在同一行的結束圓括號之後,以空格分隔。方法體應該從新的一行開始。同樣,這聽起來似乎很複雜,以下範例應該能幫助你理解這條規定。

public function __construct(
    int $size,
    string $name,
    bool $warparound = false,
    bool $aliens = false
) {
  //方法体
 }

6、行與縮排

  程式碼應該使用4個空格符來縮進,而不是使用製表符。我們可以檢查編輯器設置,將其設置為按下Tab鍵時使用4個空格而不是製表符。每行程式碼的長度不應該超過120個字元。

7、方法與函數呼叫

  方法名稱和開始圓括號之間不能有空格。方法呼叫中的參數清單的規則與方法宣告中的參數清單規則相同。換言之,對於單行調用,開始圓括號後或結束圓括號前不能有空格。每個參數之後要緊跟著一個逗號,下一個參數前面應該有一個空格。如果需要使用多行程式碼進行方法調用,那麼每個參數應該自成一行並縮進,而且結束圓括號也應該自成一行。

$earthGanme = new EarthGame( 
     5,  
     'earth',
      true,
      true
 );
$earthGame::generateTile(5, true);

8、流程控制

  流程控製關鍵字(if、for、while等)後面必須緊跟著一個空格。但是,開始圓括號後不能有空格。同樣,結束圓括號前不能有空格。因此內容應該緊貼在括號內的。與類別和(單行)函數宣告相比,流程控製程式碼的開始花括號應該與結束圓括號在同一行。結束花括號要自成一行。以下是一個簡單的範例。

$title = [];
for ($x = 0; $x < $diamondCount; $x++) { 
   if ($polluted) {
        $title[] = new PollutionDecorator(new DiamondDecorator(new Plains()));
    } else {
        $title[] = new DiamondDecorator(new Plains());
    }
}

以上是PHP程式設計風格規格詳細介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文轉載於:cnblogs.com。如有侵權,請聯絡admin@php.cn刪除