成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

PSR-1: 基礎(chǔ)編碼規(guī)范

Pluser / 2266人閱讀

摘要:源代碼文件必須只用不帶的編碼。類常量必須全部使用大寫字母和下劃線進行聲明。方法名必須聲明為樣式。類名必須聲明為的形式。面向或更高版本的代碼必須使用正式的命名空間。不論使用了哪一種風格,它應該在一個合理的范圍內(nèi)具有一致性。

翻譯:薛粲
授權(quán)許可:CC BY-NC 4.0

這份文檔是《PSR-1: Basic Coding Standard》的非官方譯文。

這份標準文檔闡述了那些需要考慮的標準的編寫代碼的原則,用于確保在共享 PHP 代碼時技術(shù)上具備較高層次的互操作性。

英文原文使用的關(guān)鍵詞 "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", 以及 "OPTIONAL" 遵循 RFC 2119 的描述。譯文中根據(jù)上下文可能會使用不同的詞匯來對應這些關(guān)鍵詞,并加粗顯示。

1. 概述

文件必須只用 標記。

PHP 源代碼文件必須只用不帶 BOM 的 UTF-8 編碼。

一個文件應該或者用于聲明各種符號(類、函數(shù)、常量等),或者發(fā)生作用(例如產(chǎn)生輸出、修改 .ini 設(shè)置等)但不應該同時做上述兩件事情。

命名空間和類必須遵循一條關(guān)于自動加載的 PSR,即 PSR-0 或 PSR-4。

類名必須聲明為 StudlyCaps 樣式。

類常量必須全部使用大寫字母和下劃線進行聲明。

方法名必須聲明為 camelCase 樣式。.

2. 文件 2.1 PHP 標記

PHP 代碼必須使用長的 標記或者短的用于輸出的 標記;不得使用其它種類的標記。

2.2 字符編碼

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

2.3 副作用

一個文件應該是:或者用于聲明新的符號(類、函數(shù)、常量等)的,同時并不導致其它副作用;或者用于執(zhí)行一些會產(chǎn)生副作用的邏輯。但是,一個文件不應該既聲明新的符號,又執(zhí)行產(chǎn)生副作用的邏輯。

短語“副作用”在這里指的是執(zhí)行那些不直接與聲明類、函數(shù)、常量等相關(guān)的邏輯,merely from including the file.

“副作用”包括但不限于:產(chǎn)生輸出、明確的使用 requireinclude,連接外部服務(wù)、修改 ini 設(shè)置、拋出錯誤或異常、修改全局或靜態(tài)變量以及讀寫文件等。

下面的示例既包含了聲明又執(zhí)行了產(chǎn)生副作用的邏輯,換句話說,這里例子是應該避免的:


";

// 聲明
function foo()
{
    // function body
}

下面的示例只包含聲明而沒有產(chǎn)生副作用,也就是說是可以借鑒的例子:


3. 命名空間和類名

命名空間和類必須遵循一份自動加載 PSR 規(guī)范:PSR-0 或 PSR-4。

這意味著每個類在一個只屬于它自己的文件中,并且至少在一層命名空間——即最頂層的提供商名——之中。

類名必須聲明為 StudlyCaps 的形式。

面向 PHP 5.3 或更高版本的代碼必須使用正式的命名空間。

例如:


面向 PHP 5.2 或更早版本的代碼應該使用以 Vendor_ 開始的偽命名空間的慣例:


4. 類常量、屬性和方法

術(shù)語“類”在這里涵蓋了類、接口和 trait。

4.1 常量

類常量必須被定義為全部由大寫字母、數(shù)字和下劃線組成,例如:


4.2 屬性

這份指南故意規(guī)避了對屬性名風格的建議,不論采用 $StudlyCaps、 $camelCase 或者 $under_score 均可。

不論使用了哪一種風格,它應該在一個合理的范圍內(nèi)具有一致性。這樣的范圍可以是開發(fā)商級別、包級別、類級別或者是方法級別的。

4.3 方法名

方法必須采用 camelCase() 風格的命名。

文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址:http://systransis.cn/yun/21442.html

相關(guān)文章

  • PSR-1 Basic Coding Standard(譯)-- 基礎(chǔ)編碼規(guī)范

    摘要:注本文算是筆者對規(guī)范翻譯學習筆記,之后會陸續(xù)翻譯剩余的規(guī)范,可能翻譯的有錯誤的地方,希望讀者能夠指正,非常感謝什么是是標準建議的簡寫,是由組織框架交互操作組織提出。的工作是尋找項目之間的共性,以及讓開發(fā)者能更好協(xié)同工作的方式。 注:本文算是筆者對PSR規(guī)范翻譯/學習筆記,之后會陸續(xù)翻譯剩余的規(guī)范,可能翻譯的有錯誤的地方,希望讀者能夠指正,非常感謝. 什么是PSR? ? ??? PSR是...

    darryrzhong 評論0 收藏0
  • PHP中對PSR-1、PSR-2規(guī)范理解

    摘要:目前已表決通過了套標準,已經(jīng)得到大部分框架的支持和認可。類中的常量所有字母都必須大寫,單詞間用下劃線分隔方法名稱必須符合式的小寫開頭駝峰命名規(guī)范。日志接口規(guī)范詳見自動加載規(guī)范詳見緩存接口規(guī)范詳見消息接口規(guī)范詳見,暫無中文翻譯 PHP-FIG 在說啥是PSR-[0-4]規(guī)范的之前,我覺得我們有必要說下它的發(fā)明者和規(guī)范者:PHP-FIG。就是這個聯(lián)盟組織發(fā)明和創(chuàng)造了PSR-[0-4]規(guī)范 ...

    lieeps 評論0 收藏0
  • PHP 標準規(guī)范

    摘要:標準規(guī)范簡介是的簡寫,由組織制定的規(guī)范,是開發(fā)的實踐標準。具體標準有有了統(tǒng)一編碼風格規(guī)范,更有利于查看和學習各個框架或類庫,不不需要每次都適應新的編碼風格。同時在開發(fā)團隊內(nèi)部使用統(tǒng)一的編碼規(guī)范更有利于代碼審查版本控制團隊內(nèi)部交流。 PHP 標準規(guī)范 PSR PSR 簡介 PSR 是 PHP Standard Recommendations 的簡寫,由 PHP FIG 組織制定的 PHP...

    FuisonDesign 評論0 收藏0
  • PSR-2:編碼樣式指南

    摘要:編碼樣式指南翻譯薛粲授權(quán)許可這份文檔是的非官方譯文。編碼樣式指南擴展和擴充了基礎(chǔ)編碼規(guī)范。概述代碼必須遵循一份編碼樣式指南。行不得對行寬設(shè)置硬性限制。對行寬的軟性限制必須是個字符超出時自動樣式檢查必須發(fā)出警告但不得產(chǎn)生錯誤。 PSR-2:編碼樣式指南 翻譯:薛粲授權(quán)許可:CC BY-NC 4.0 這份文檔是《PSR-2: Coding Style Guide》的非官方譯文。 《PSR-...

    K_B_Z 評論0 收藏0
  • php-psr-chinese psr規(guī)范總結(jié)

    摘要:公認規(guī)范總結(jié)規(guī)范中文版大部分來源翻譯部分包含例子,附錄包含了一些規(guī)范的實現(xiàn)基本編碼標準編碼風格指南日志接口規(guī)范自動加載規(guī)范規(guī)范英文版未使用草案已棄用規(guī)范原理實現(xiàn)實現(xiàn)自動加載實現(xiàn)原理資料來源與參考 PSR公認規(guī)范總結(jié) PSR規(guī)范中文版(大部分來源google翻譯)(cn) 部分psr包含例子,附錄包含了一些規(guī)范的實現(xiàn) PSR-1:基本編碼標準 PSR-2:編碼風格指南 PSR-3:日志...

    tuomao 評論0 收藏0

發(fā)表評論

0條評論

最新活動
閱讀需要支付1元查看
<