PHP PSR-1 基本代码规范(中文版)

时间 2019-11-17

标签 php psr 基本代码规范中文版栏目 PHP 繁體版

原文原文链接

基本代码规范

本篇规范制定了代码基本元素的相关标准，
以确保共享的PHP代码间具备较高程度的技术互通性。php

关键词 “必须”("MUST")、“必定不可/必定不能”("MUST NOT")、“须要”("REQUIRED")、
“将会”("SHALL")、“不会”("SHALL NOT")、“应该”("SHOULD")、“不应”("SHOULD NOT")、
“推荐”("RECOMMENDED")、“能够”("MAY")和”可选“("OPTIONAL")的详细描述可参见 RFC 2119 。html

1. 概览

PHP代码文件必须以 <?php 或 <?= 标签开始；git
PHP代码文件必须以 不带BOM的 UTF-8 编码；github
PHP代码中应该只定义类、函数、常量等声明，或其余会产生 从属效应 的操做（如：生成文件输出以及修改.ini配置文件等），两者只能选其一；segmentfault
命名空间以及类必须符合 PSR 的自动加载规范：PSR-0 或 PSR-4 中的一个；ide
类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范；函数
类中的常量全部字母都必须大写，单词间用下划线分隔；ui
方法名称必须符合 camelCase 式的小写开头驼峰命名规范。编码

2. 文件

2.1. PHP标签

PHP代码必须使用 <?php ?> 长标签或 <?= ?> 短输出标签；
必定不可使用其它自定义标签。spa

2.2. 字符编码

PHP代码必须且只可以使用不带BOM的UTF-8编码。

2.3. 从属效应（反作用）

一份PHP文件中应该要不就只定义新的声明，如类、函数或常量等不产生从属效应的操做，要不就只有会产生从属效应的逻辑操做，但不应同时具备二者。

“从属效应”(side effects)一词的意思是，仅仅经过包含文件，不直接声明类、
函数和常量等，而执行的逻辑操做。

“从属效应”包含却不只限于：生成输出、直接的 require 或 include、链接外部服务、修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。

如下是一个反例，一份包含声明以及产生从属效应的代码：

<?php// 从属效应：修改 ini 配置ini_set('error_reporting', E_ALL);// 从属效应：引入文件include "file.php";// 从属效应：生成输出echo "<html>\n";// 声明函数function foo(){    // 函数主体部分}