摘要:基本代碼規范本篇規范制定了代碼基本元素的相關標準,以確保共享的代碼間具有較高程度的技術互通性。從屬效應一詞的意思是,僅僅通過包含文件,不直接聲明類函數和常量等,而執行的邏輯操作。及以后版本的代碼必須使用正式的命名空間。
基本代碼規范
本篇規范制定了代碼基本元素的相關標準,
以確保共享的PHP代碼間具有較高程度的技術互通性。
關鍵詞 “必須”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、
“將會”("SHALL")、“不會”("SHALL NOT")、“應該”("SHOULD")、“不該”("SHOULD NOT")、
“推薦”("RECOMMENDED")、“可以”("MAY")和”可選“("OPTIONAL")的詳細描述可參見 [RFC 2119][] 。
概覽
PHP代碼文件必須以 或 = 標簽開始;
PHP代碼文件必須以 不帶BOM的 UTF-8 編碼;
PHP代碼中應該只定義類、函數、常量等聲明,或其他會產生 從屬效應 的操作(如:生成文件輸出以及修改.ini配置文件等),二者只能選其一;
命名空間以及類必須符合 PSR 的自動加載規范:PSR-0[] 中的一個;
類的命名必須遵循 StudlyCaps 大寫開頭的駝峰命名規范;
類中的常量所有字母都必須大寫,單詞間用下劃線分隔;
方法名稱必須符合 camelCase 式的小寫開頭駝峰命名規范。
文件
PHP代碼必須使用 長標簽 或 = ?> 短輸出標簽;
一定不可使用其它自定義標簽。
PHP代碼必須且只可使用不帶BOM的UTF-8編碼。
2.3. 從屬效應(副作用)一份PHP文件中應該要不就只定義新的聲明,如類、函數或常量等不產生從屬效應的操作,要不就只有會產生從屬效應的邏輯操作,但不該同時具有兩者。
“從屬效應”(side effects)一詞的意思是,僅僅通過包含文件,不直接聲明類、
函數和常量等,而執行的邏輯操作。
“從屬效應”包含卻不僅限于:生成輸出、直接的 require 或 include、連接外部服務、修改 ini 配置、拋出錯誤或異常、修改全局或靜態變量、讀或寫文件等。
以下是一個反例,一份包含聲明以及產生從屬效應的代碼:
"; // 聲明函數 function foo() { // 函數主體部分 }
下面是一個范例,一份只包含聲明不產生從屬效應的代碼:
命名空間和類
命名空間以及類的命名必須遵循 [PSR-0][].
根據規范,每個類都獨立為一個文件,且命名空間至少有一個層次:頂級的組織名稱(vendor name)。
類的命名必須 遵循 StudlyCaps 大寫開頭的駝峰命名規范。
PHP 5.3及以后版本的代碼必須使用正式的命名空間。
例如:
5.2.x及之前的版本應該使用偽命名空間的寫法,約定俗成使用頂級的組織名稱(vendor name)如 Vendor_ 為類前綴。
類的常量、屬性和方法
此處的“類”指代所有的類、接口以及可復用代碼塊(traits)
4.1. 常量類的常量中所有字母都必須大寫,詞間以下劃線分隔。
參照以下代碼:4.2. 屬性類的屬性命名可以遵循 大寫開頭的駝峰式 ($StudlyCaps)、小寫開頭的駝峰式 ($camelCase) 又或者是 下劃線分隔式 ($under_score),本規范不做強制要求,但無論遵循哪種命名方式,都應該在一定的范圍內保持一致。這個范圍可以是整個團隊、整個包、整個類或整個方法。
4.3. 方法方法名稱必須符合 camelCase() 式的小寫開頭駝峰命名規范。
轉自Github(PizzaLiu)
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/21162.html
摘要:是一系列關于開發的規范,分有好幾個版本,自己學的也較為膚淺,但還是希望能時常查看規范,為了方便記憶和遵循,我把關鍵詞為必須的撿拾出來,做個簡單地必要規范的記錄。所有文件必須使用作為行的結束符。 PSR是一系列關于PHP開發的規范,分有好幾個版本,自己學的也較為膚淺,但還是希望能時常查看規范,為了方便記憶和遵循,我把關鍵詞為必須的撿拾出來,做個簡單地必要規范的記錄。(就是個搬磚的。。。)...
摘要:參考自動加載已廢棄基本代碼規范代碼樣式日志接口如何指定文件路徑從而自動加載類定義基本代碼規范本篇規范制定了代碼基本元素的相關標準,以確保共享的代碼間具有較高程度的技術互通性。 概述 PSR 不是PHP官方標準,而是從如Zend、Symfony2等知名PHP項目中提煉出來的一系列標準,目前有越來越多的社區項目加入并遵循該標準。 參考:http://psr.phphub.org/ PSR-...
摘要:的使命是實現框架之間的互操作性。個人和官方都認為開發者應該遵循更為嚴格的代碼標準,在現代的生態系統中,風格統一,可以更好的讓其他開發者理解代碼。記錄的消息用于診斷檢查和排除應用中的操作穩定性和性能方面的問題。 原文是在我自己博客中,小伙伴也可以點閱讀原文進行跳轉查看,還有好聽的背景音樂噢~ ????PSR是PHP Standards Recommendation的簡稱,意為PHP推薦標...
摘要:制定的規范,簡稱,是開發的事實標準。原本有四個規范,分別是自動加載基本代碼規范代碼樣式日志接口年底,新出了第個規范。區別在于的規范比較干凈,去除了兼容以前版本的內容,有一點升級版的感覺。 FIG制定的PHP規范,簡稱PSR,是PHP開發的事實標準。 PSR原本有四個規范,分別是: PSR-0 自動加載 PSR-1 基本代碼規范 PSR-2 代碼樣式 PSR-3 日志接口 20...
摘要:本文目的是通過自己寫的一個的簡單的庫花密密碼生成工具,來學習我認為的庫開發的一些規范,以及上持續構建你的項目的一些方法。給自己的項目開啟持續構建。包發布以及當你的代碼完成后,測試完成后。 本文目的是通過自己寫的一個php的簡單的庫(花密密碼生成工具), 來學習我認為的php庫開發的一些規范,以及github上持續構建你的項目的一些方法。其實是為了顯示下邊一系列的的徽章 showImg(...
閱讀 1958·2021-11-16 11:45
閱讀 3668·2021-09-06 15:02
閱讀 2013·2019-08-30 15:44
閱讀 2283·2019-08-30 11:21
閱讀 1845·2019-08-29 16:31
閱讀 3422·2019-08-29 13:55
閱讀 1895·2019-08-29 12:15
閱讀 3251·2019-08-28 18:05