PHP編碼規範(PSR)的簡述

PSR簡介

PSR是一系列關於PHP開發的規範，通常你們遵照的是 php-fig定義的規範，中文翻譯版本參考目前官方已制定的規範包括如下六份文件：

• PSR-0 (棄用)
• PSR-1 (基本代碼規範)
• PSR-2 (代碼風格規範)
• PSR-2補充
• PSR-3 (日誌接口規範)
• PSR-4 (自動載入)

PSR-1 基本代碼規範

概況

• 代碼文件必須以<?php或 <?= 標籤開始
• 代碼文件必須以不帶BOM頭的 UTF-8 編碼
• 代碼文件中應該只定義類(class)、函數(function)、常量(constants)等聲明,或其餘會產生從屬效應 的操做(如:生成文件輸出以及修改.ini配置文件等),兩者只能選其一,也就是說功能惟一;
• 命名空間以及類必須符合 PSR 的自動加載規範：PSR-4;
• 類的命名必須遵循StudlyCaps大寫開頭的駝峯命名規範;
• 類中的常量全部字母都必須大寫，單詞間用下劃線分隔;
• 方法名稱必須符合camelCase式的小寫開頭駝峯命名規範;

PHP編碼規範(PSR-1)

PSR-2 代碼風格規範

概況

• 代碼必須遵循 PSR-1 中的編碼規範 。
• 代碼必須使用4個空格符而不是tab鍵 進行縮進。
• 每行的字符數應該軟性保持在80個以內,理論上必定不可多於120個,但必定不能有硬性限制。
• 每一個 namespace 命名空間聲明語句和 use 聲明語句塊後面，必須插入一個空白行。
• 類的開始花括號({)必須寫在函數聲明後自成一行，結束花括號(})也必須寫在函數主體後自成一行。
• 方法的開始花括號({)必須寫在函數聲明後自成一行,結束花括號(})也必須寫在函數主體後自成一行。
• 類的屬性和方法必須添加訪問修飾符(private、protected以及public),abstract 以及 final 必須聲明在訪問修飾符以前,而static必須聲明在訪問修飾符以後。
• 控制結構的關鍵字後必需要有一個空格符,而調用方法或函數時則必定不能有。
• 控制結構的開始花括號({)必須寫在聲明的同一行，而結束花括號(})必須寫在主體後自成一行。
• 控制結構的開始左括號後和結束右括號前,都必定不能有空格符。

PHP編碼規範(PSR-2)

PSR-4 Autoloader

概述

本 PSR 是關於由文件路徑 自動載入 對應類的相關規範， 本規範是可互操做的，能夠做爲任一自動載入規範的補充，其中包括 PSR-0，此外， 本 PSR 還包括自動載入的類對應的文件存放路徑規範。

PHP編碼規範Autoloader(PSR-4)

在規定好代碼規範以後,如何用工具去修改和修正代碼文件呢，能夠繼續閱讀

PHP 編碼格式化工具 PHP-CS-Fixer的使用