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