PHP PSR-1 基本代码规范(中文版),_PHP教程
PHP PSR-1 基本代码规范(中文版),
基本代码规范
本篇规范制定了代码基本元素的相关标准,
以确保共享的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 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。
以下是一个反例,一份包含声明以及产生从属效应的代码:
<code class="php"><span class="hljs-preprocessor"><?php <span class="hljs-comment">// 从属效应:修改 ini 配置 ini_set(<span class="hljs-string">'error_reporting', E_ALL); <span class="hljs-comment">// 从属效应:引入文件 <span class="hljs-keyword">include <span class="hljs-string">"file.php"; <span class="hljs-comment">// 从属效应:生成输出 <span class="hljs-keyword">echo <span class="hljs-string">"<html>\n"; <span class="hljs-comment">// 声明函数 <span class="hljs-function"><span class="hljs-keyword">function <span class="hljs-title">foo<span class="hljs-params">() { <span class="hljs-comment">// 函数主体部分 } </span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></code>
下面是一个范例,一份只包含声明不产生从属效应的代码:
<code class="php"><span class="hljs-preprocessor"><?php <span class="hljs-comment">// 声明函数 <span class="hljs-function"><span class="hljs-keyword">function <span class="hljs-title">foo<span class="hljs-params">() { <span class="hljs-comment">// 函数主体部分 } <span class="hljs-comment">// 条件声明**不**属于从属效应 <span class="hljs-keyword">if (! function_exists(<span class="hljs-string">'bar')) { <span class="hljs-function"><span class="hljs-keyword">function <span class="hljs-title">bar<span class="hljs-params">() { <span class="hljs-comment">// 函数主体部分 } } </span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></code>
3. 命名空间和类
命名空间以及类的命名必须遵循 PSR-0.
根据规范,每个类都独立为一个文件,且命名空间至少有一个层次:顶级的组织名称(vendor name)。
类的命名必须 遵循 StudlyCaps
大写开头的驼峰命名规范。
PHP 5.3及以后版本的代码必须使用正式的命名空间。
例如:
<code class="php"><span class="hljs-preprocessor"><?php <span class="hljs-comment">// PHP 5.3及以后版本的写法 <span class="hljs-keyword">namespace <span class="hljs-title">Vendor\<span class="hljs-title">Model; <span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">Foo { } </span></span></span></span></span></span></span></span></code>
5.2.x及之前的版本应该使用伪命名空间的写法,约定俗成使用顶级的组织名称(vendor name)如 Vendor_
为类前缀。
<code class="php"><span class="hljs-preprocessor"><?php <span class="hljs-comment">// 5.2.x及之前版本的写法 <span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">Vendor_Model_Foo { } </span></span></span></span></span></code>
4. 类的常量、属性和方法
此处的“类”指代所有的类、接口以及可复用代码块(traits)
4.1. 常量
类的常量中所有字母都必须大写,词间以下划线分隔。
参照以下代码:
<code class="php"><span class="hljs-preprocessor"><?php <span class="hljs-keyword">namespace <span class="hljs-title">Vendor\<span class="hljs-title">Model; <span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">Foo { <span class="hljs-keyword">const VERSION = <span class="hljs-string">'1.0'; <span class="hljs-keyword">const DATE_APPROVED = <span class="hljs-string">'2012-06-01'; } </span></span></span></span></span></span></span></span></span></span></span></code>
4.2. 属性
类的属性命名可以遵循 大写开头的驼峰式 ($StudlyCaps
)、小写开头的驼峰式 ($camelCase
) 又或者是 下划线分隔式 ($under_score
),本规范不做强制要求,但无论遵循哪种命名方式,都应该在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。
4.3. 方法
方法名称必须符合 camelCase()
式的小写开头驼峰命名规范。
因psr-0已废弃故没有转
原文:PizzaLiu github

熱AI工具

Undresser.AI Undress
人工智慧驅動的應用程序,用於創建逼真的裸體照片

AI Clothes Remover
用於從照片中去除衣服的線上人工智慧工具。

Undress AI Tool
免費脫衣圖片

Clothoff.io
AI脫衣器

AI Hentai Generator
免費產生 AI 無盡。

熱門文章

熱工具

記事本++7.3.1
好用且免費的程式碼編輯器

SublimeText3漢化版
中文版,非常好用

禪工作室 13.0.1
強大的PHP整合開發環境

Dreamweaver CS6
視覺化網頁開發工具

SublimeText3 Mac版
神級程式碼編輯軟體(SublimeText3)

熱門話題

PHP 8.4 帶來了多項新功能、安全性改進和效能改進,同時棄用和刪除了大量功能。 本指南介紹如何在 Ubuntu、Debian 或其衍生版本上安裝 PHP 8.4 或升級到 PHP 8.4

CakePHP 是 PHP 的開源框架。它旨在使應用程式的開發、部署和維護變得更加容易。 CakePHP 基於類似 MVC 的架構,功能強大且易於掌握。模型、視圖和控制器 gu

Visual Studio Code,也稱為 VS Code,是一個免費的原始碼編輯器 - 或整合開發環境 (IDE) - 可用於所有主要作業系統。 VS Code 擁有大量針對多種程式語言的擴展,可以輕鬆編寫

本教程演示瞭如何使用PHP有效地處理XML文檔。 XML(可擴展的標記語言)是一種用於人類可讀性和機器解析的多功能文本標記語言。它通常用於數據存儲

CakePHP 是一個開源MVC 框架。它使應用程式的開發、部署和維護變得更加容易。 CakePHP 有許多函式庫可以減少大多數常見任務的過載。

字符串是由字符組成的序列,包括字母、數字和符號。本教程將學習如何使用不同的方法在PHP中計算給定字符串中元音的數量。英語中的元音是a、e、i、o、u,它們可以是大寫或小寫。 什麼是元音? 元音是代表特定語音的字母字符。英語中共有五個元音,包括大寫和小寫: a, e, i, o, u 示例 1 輸入:字符串 = "Tutorialspoint" 輸出:6 解釋 字符串 "Tutorialspoint" 中的元音是 u、o、i、a、o、i。總共有 6 個元

JWT是一種基於JSON的開放標準,用於在各方之間安全地傳輸信息,主要用於身份驗證和信息交換。 1.JWT由Header、Payload和Signature三部分組成。 2.JWT的工作原理包括生成JWT、驗證JWT和解析Payload三個步驟。 3.在PHP中使用JWT進行身份驗證時,可以生成和驗證JWT,並在高級用法中包含用戶角色和權限信息。 4.常見錯誤包括簽名驗證失敗、令牌過期和Payload過大,調試技巧包括使用調試工具和日誌記錄。 5.性能優化和最佳實踐包括使用合適的簽名算法、合理設置有效期、
