PHP PSR-1 基本代碼規範(中文版)

來源:互聯網
上載者:User

標籤:file   name   code   hal   部分   全域   元素   rfc   執行   

基本代碼規範

本篇規範制定了代碼基本元素的相關標準, 以確保共用的PHP代碼間具有較高程度的技術互連性。

關鍵詞 “必須”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、
“將會”("SHALL")、“不會”("SHALL NOT")、“應該”("SHOULD")、“不該”("SHOULD NOT")、
“推薦”("RECOMMENDED")、“可以”("MAY")和”可選“("OPTIONAL")的詳細描述可參見 RFC 2119 。

1. 概覽
  • PHP代碼檔案必須以 <?php 或 <?= 標籤開始;

  • PHP代碼檔案必須以 不帶BOM的 UTF-8 編碼;

  • PHP代碼中應該只定義類、函數、常量等聲明,或其他會產生 從屬效應 的操作(如:組建檔案輸出以及修改.ini設定檔等),二者只能選其一;

  • 命名空間以及類必須符合 PSR 的自動載入規範:PSR-0 或 PSR-4 中的一個;

  • 類的命名必須遵循 StudlyCaps 大寫開頭的駝峰命名規範;

  • 類中的常量所有字母都必須大寫,單詞間用底線分隔;

  • 方法名稱必須符合 camelCase 式的小寫開頭駝峰命名規範。

2. 檔案2.1. PHP標籤

PHP代碼必須使用 <?php ?> 長標籤 或 <?= ?> 短輸出標籤;
一定不可使用其它自訂標籤。

2.2. 字元編碼

PHP代碼必須且只可使用不帶BOM的UTF-8編碼。

2.3. 從屬效應(副作用)

一份PHP檔案中應該要不就只定義新的聲明,如類、函數或常量等不產生從屬效應的操作,要不就只有會產生從屬效應的邏輯操作,但不該同時具有兩者。

“從屬效應”(side effects)一詞的意思是,僅僅通過包含檔案,不直接聲明類、 函數和常量等,而執行的邏輯操作。

“從屬效應”包含卻不僅限於:產生輸出、直接的 require 或 include、串連外部服務、修改 ini 配置、拋出錯誤或異常、修改全域或靜態變數、讀或寫檔案等。

以下是一個反例,一份包含聲明以及產生從屬效應的代碼:

<?php// 從屬效應:修改 ini 配置ini_set(‘error_reporting‘, E_ALL);// 從屬效應:引入檔案include "file.php";// 從屬效應:產生輸出echo "<html>\n";// 聲明函數function foo(){    // 函數主體部分}

  

下面是一個範例,一份只包含聲明不產生從屬效應的代碼:

<?php// 聲明函數function foo(){    // 函數主體部分}// 條件聲明**不**屬於從屬效應if (! function_exists(‘bar‘)) {    function bar()    {        // 函數主體部分    }}

  

3. 命名空間和類

命名空間以及類的命名必須遵循 PSR-0.(PSR-0已廢棄)

根據規範,每個類都獨立為一個檔案,且命名空間至少有一個層次:頂級的組織名稱(vendor name)。

類的命名必須 遵循 StudlyCaps 大寫開頭的駝峰命名規範。

PHP 5.3及以後版本的代碼必須使用正式的命名空間。

例如:

<?php// PHP 5.3及以後版本的寫法namespace Vendor\Model;class Foo{}

  

5.2.x及之前的版本應該使用偽命名空間的寫法,約定俗成使用頂級的組織名稱(vendor name)如 Vendor_ 為類首碼。

<?php// 5.2.x及之前版本的寫法class Vendor_Model_Foo{}

  

4. 類的常量、屬性和方法

此處的“類”指代所有的類、介面以及可複用代碼塊(traits)

4.1. 常量

類的常量中所有字母都必須大寫,詞間以底線分隔。
參照以下代碼:

<?phpnamespace Vendor\Model;class Foo{    const VERSION = ‘1.0‘;    const DATE_APPROVED = ‘2012-06-01‘;}

  

4.2. 屬性

類的屬性命名可以遵循 大寫開頭的駝峰式 ($StudlyCaps)、小寫開頭的駝峰式 ($camelCase) 又或者是 底線分隔式 ($under_score),本規範不做強制要求,但無論遵循哪種命名方式,都應該在一定的範圍內保持一致。這個範圍可以是整個團隊、整個包、整個類或整個方法。

4.3. 方法

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

PHP PSR-1 基本代碼規範(中文版)

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.