PSR-1 Basic Coding Standard(譯)-- 基礎編碼規范

darryrzhong 發布于2019-06-27 17:11 / 2932人閱讀

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

注:本文算是筆者對PSR規范翻譯/學習筆記，之后會陸續翻譯剩余的規范，可能翻譯的有錯誤的地方，希望讀者能夠指正，非常感謝.

什么是PSR？

? ??? PSR是PHP Standards Recommendations(PHP標準建議) 的簡寫，是由PHP-FIG組織(PHP Framework Interop Group-PHP框架交互操作組織)提出。PHP-FIG的工作是尋找項目之間的共性，以及讓開發者能更好協同工作的方式。讀者可能在瀏覽一些PHP技術文章的時候，可能會看到PSR-1,PSR-2,PSR-4,PSR-7等，這些是PHP-FIG的標準建議，這些標準建議的命名構成是以"PSR-"+"序號"，每個PHP_FIG標準建議都是為了解決大部分框架頻繁遇到的一個特定的問題，而與此同時框架不需要自己再去重復解決問題,而是遵循PSR標準建議，采納共享的解決方案.

目前PSR規范有哪些?

PSR規范

PSR-1: Basic Coding Standard

PSR-2: Coding Style Guide

PSR-3: Logger Interface

PSR-4: Autoloader

PSR-6: Caching Interface

PSR-7: HTTP message interfaces

PSR-11: Container interface

PSR-13: Link definition interfaces

PSR-16: Common Interface for Caching Libraries

什么是 PSR-1?

原文鏈接:PSR-1 Basic Coding Standard

Aims to ensure a high level of technical interoperability between shared PHP code.

PSR-1 就是為了能夠使共享的PHP代碼之間有高度的互操作性.

OverView (概覽)

PHP文件(MUST)必須只使用

PHP文件(MUST)必須只能使用無BOM頭的UTF-8編碼格式.

PHP文件(SHOULD)應該要么聲明 classe，functions。constants 等等,或者 general ouput(通用輸出?),改變php.ini的配置等等，但是(SHOULD Not)不應該兩個都有.

命名空間和類(MUST)必須要遵循自動加載的PSR規范[PSR-0,PSR-4];

類名明明(MUST)必須以大駝峰式.

類中的常量的命名(MUST)必須為以下劃線分割的大寫字母.

方法名(MUST)必須為小駝峰式.

PHP Tags

PHP代碼(MUST)必須使用長標簽或者短標簽 ;(MUST NOT)不能有其他類型的寫法.

Character Encoding

PHP代碼(MUST)必須只使用無BOM頭的UTF-8編碼格式.

Side Effects

?????一個PHP文件(SHOULD)必須要聲明一些class,function,constant等,并且沒有side effects (執行邏輯),或者(SHOULD)應該有side effects(執行邏輯),但是(SHOULD NOT)不應該兩個都同時存在.

???"side effects"代表的就是和聲明class,function,constant等不直接相關聯的執行邏輯，僅僅來自這個包含的文件。

??"Side effects" 包含以下操作,但不僅限于此：general output(通用輸出), "require"和"include"的使用,連接外部服務,修改php.ini的設置,觸發錯誤或者拋出異常,修改全局或者靜態變量,讀取或者寫入文件操作等等.

??以下是一個我們要避免的例子,就是一個具有"declarations"和side effects的PHP文件。


";

// declaration
function foo()
{
    // function body
}

以下是一個是正確的例子，只包含了"declaraion"沒有"side effects".


Namespace and Class Names
This means each class is in a file by itself, and is in a namespace of at least one level: a top-level vendor name
???命名空間和類(MUST)必須要遵循自動加載規范【PSR-0，PSR-4】,這意味著每個類在一個文件中，并且至少在一個level的命名空間中:最高level的vendor名稱.
???類名命名必須以大駝峰式.
???PHP5.3及以后版本中，寫代碼(MUST)必須使用正式的命名空間.
For example:

???PHP5.2.x以及之前的版本(SHOULD)應該使用pseudo-namespacing(偽命名空間)的慣例：在類名前+"Vendor_"前綴.

The term “class” refers to all classes, interfaces, and traits.
本文中的術語class,代表的是所有的class,interface,traits。
Constants
類中的常量(MUST)必須為以下劃線分割的大寫字母.
for example:

Properties
對于類的屬性，本文檔有意省略了對屬性名的命名方式.(大駝峰/小駝峰/下劃線等)
無論采用什么樣的命名方式(SHOULD)應該和其所在scope相一致.scope 可能為vendor級別，package級別，class級別,或者method級別.
Methods
方法名(MUST)必須聲明為小駝峰式.

云服務器 GPU云服務器規范編碼編碼規范 basic語言基礎教程 php編碼規范

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/23342.html

php-psr-chinese psr規范總結

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

tuomao 2019-06-27 16:56 評論0 收藏0
PHP 標準規范

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

FuisonDesign 2019-07-01 10:06 評論0 收藏0
利用 Composer 一步一步構建自己的 PHP 框架（一）——基礎準備

摘要：原文發表在我的個人網站利用一步一步構建自己的框架一基礎準備一統天下的時代已經到來白巖松一個時代結束了另一個時代開始了。框架可互用性小組，簡稱，成立于年。原文發表在我的個人網站利用 Composer 一步一步構建自己的 PHP 框架（一）——基礎準備『Composer 一統天下的時代已經到來！』 ——白巖松一個時代結束了,另一個時代開始了。 Framework ...

gougoujiang 2019-07-01 14:12 評論0 收藏0
PSR-1: 基礎編碼規范

摘要：源代碼文件必須只用不帶的編碼。類常量必須全部使用大寫字母和下劃線進行聲明。方法名必須聲明為樣式。類名必須聲明為的形式。面向或更高版本的代碼必須使用正式的命名空間。不論使用了哪一種風格，它應該在一個合理的范圍內具有一致性。翻譯：薛粲授權許可：CC BY-NC 4.0 這份文檔是《PSR-1: Basic Coding Standard》的非官方譯文。這份標準文檔闡述了那些需要考慮的標...

Pluser 2019-06-27 12:08 評論0 收藏0
現在寫 PHP，你應該知道這些

摘要：首先你應該是在用以上的版本，如果版本在這之下，是時候該升級了。按照其官網的說法，這個組織的目的并不是告訴你你應該怎么做，只是一些主流的框架之間相互協商和約定。和沒有出現在以上的列表中，是因為還沒有投票通過。不要被這些話所困擾。首先你應該是在用 PHP 5.3 以上的版本，如果 PHP 版本在這之下，是時候該升級了。我建議如果有條件，最好使用最新的版本。你應該看過 PHP The R...

supernavy 2019-06-27 11:37 評論0 收藏0