文档章节

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

china008
 china008
发布于 2015/12/31 17:05
字数 588
阅读 46
收藏 5

基本代码规范

本篇规范制定了代码基本元素的相关标准,
以确保共享的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 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。

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

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


本文转载自:http://segmentfault.com/a/1190000002521577

共有 人打赏支持
china008
粉丝 5
博文 286
码字总数 30406
作品 0
海淀
加载中

评论(1)

JPer
JPer
乱七八糟;
FIG-PHP PSR规范系列1-基础编码规范

FIG-PHP与PSR简介 FIG-PHP制定了一系列PHP开发规范,简称PSR,这里FIG是框架互操作工作组(Framework Interoperability Group)的简称,PSR是PHP标准推荐(PHP Standard Recommendation)的缩...

一配
2015/07/29
0
0
PHP编码规范(PSR)的简述

PSR简介 PSR是一系列关于PHP开发的规范,一般大家遵守的是 php-fig定义的规范,中文翻译版本参考目前官方已制定的规范包括以下六份文件: PSR-0 (弃用) PSR-1 (基本代码规范) PSR-2 (代码风格...

2688
2016/07/04
335
0
PHP编码规范(PSR-2)-代码风格规范

PSR-2 代码风格规范 1. 概况 代码必须遵循 PSR-1 中的编码规范 。 代码必须使用而不是键 进行缩进。 每行的字符数应该软性保持在个之内,理论上一定不可多于个,但一定不能有硬性限制。 每个 ...

2688
2016/07/04
87
0
PHP编码规范(PSR-4)-Autoloader 自动加载

PSR-4 Autoloader 1. 概述 本 PSR 是关于由文件路径 自动载入 对应类的相关规范, 本规范是可互操作的,可以作为任一自动载入规范的补充,其中包括 PSR-0,此外, 本 PSR 还包括自动载入的类...

2688
2016/07/04
57
0
PHP代码规范检测 - SVN服务端配置

代码质量的检测插件有很多,这里只拿最基本的PSR做介绍。 长期以来,我们一直再做自己的代码规范,对新入职的员工进行培训。然而,效果却不是特别好。 代码规范不能顺利执行的主要原因有以下...

Dorm_Script
2016/11/15
0
0

没有更多内容

加载失败,请刷新页面

加载更多

ionic安卓打包过程

在项目文件夹下执行命令 ionic cordova platform add android 打开android studio -> Configure->SDK Manager 安装android 26...

lilugirl
4分钟前
0
0
arts-week14

Algorithm 923. 3Sum With Multiplicity - LeetCode Review Building a network attached storage device with a Raspberry Pi 搭建家用储存系统,使用树莓派和移动硬盘,搭建一个 NAS,操作......

yysue
6分钟前
0
0
理解OAuth 2.0

OAuth是一个关于授权(authorization)的开放网络标准,在全世界得到广泛应用,目前的版本是2.0版。 本文对OAuth 2.0的设计思路和运行流程,做一个简明通俗的解释,主要参考材料为RFC 6749。...

吴伟祥
19分钟前
0
0
源码中常用英文单词

Resolver BeansDtdResolver : spring bean dtd 解析器

职业搬砖工程师
20分钟前
0
0
区块链入门教程以太坊源码分析event源码分析

兄弟连区块链入门教程以太坊源码分析event源码分析,2018年下半年,区块链行业正逐渐褪去发展之初的浮躁、回归理性,表面上看相关人才需求与身价似乎正在回落。但事实上,正是初期泡沫的渐退...

兄弟连区块链入门教程
21分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部