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

登录 CakePHP 是一项非常简单的任务。您只需使用一项功能即可。您可以记录任何后台进程(如 cronjob)的错误、异常、用户活动、用户采取的操作。在 CakePHP 中记录数据很容易。提供了 log() 函数

Visual Studio Code,也称为 VS Code,是一个免费的源代码编辑器 - 或集成开发环境 (IDE) - 可用于所有主要操作系统。 VS Code 拥有针对多种编程语言的大量扩展,可以轻松编写
