PSR 您所在的位置:网站首页 php命名规范 PSR

PSR

2024-01-08 17:22| 来源: 网络整理| 查看: 265

编码风格指南

本篇规范是 PSR-1基本代码规范的继承与扩展。

本规范希望通过制定一系列规范化 PHP 代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便。

当多名程序员在多个项目中合作时,就需要一个共同的编码规范, 而本文中的风格规范源自于多个不同项目代码风格的共同特性, 因此,本规范的价值在于我们都遵循这个编码风格,而不是在于它本身。

本文件中的 必须,不得,需要,应,不应,应该,不应该,推荐,可能 和 可选 等能愿动词按照 RFC 2119 中的描述进行解释。

1. 概览

代码 必须 遵循 [PSR-1] 中的编码规范 。

代码 必须 使用 4 个空格符而不是「Tab 键」进行缩进。

每行的字符数 应该 软性保持在 80 个之内,理论上 一定不可 多于 120 个,但 一定不可 有硬性限制。

每个 namespace 命名空间声明语句和 use 声明语句块后面,必须 插入一个空白行。

类的开始花括号({) 必须 写在类声明后自成一行,结束花括号(})也 必须 写在类主体后自成一行。

方法的开始花括号({) 必须 写在函数声明后自成一行,结束花括号(})也 必须 写在函数主体后自成一行。

类的属性和方法 必须 添加访问修饰符(private、protected 以及 public),abstract 以及 final 必须 声明在访问修饰符之前,而 static 必须 声明在访问修饰符之后。

控制结构的关键字后 必须 要有一个空格符,而调用方法或函数时则 一定不可 有。

控制结构的开始花括号({) 必须 写在声明的同一行,而结束花括号(}) 必须 写在主体后自成一行。

控制结构的开始左括号后和结束右括号前,都 一定不可 有空格符。

1.1. 示例

本示例将作为下文规则的快速概览:

结束标签。

2.3. 行

行的长度 一定不可 有硬性的约束。

软性的长度约束 必须 要限制在 120 个字符以内,若超过此长度,带代码规范检查的编辑器 必须 要发出警告,不过 一定不可 发出错误提示。

每行 不该 多于80个字符,大于80字符的行 应该 折成多行。

非空行后 一定不可 有多余的空格符。

空行 可以 使得阅读代码更加方便以及有助于代码的分块。

每行 一定不可 存在多于一条语句。

2.4. 缩进

代码 必须 使用 4 个空格来进行缩进, 并且 一定不能 使用 tab 键来缩进。

注:仅使用空格,而不是使用空格和 tab 键混在一起, 能帮助避免在查看代码差异,打补丁,查看提交历史,以及进行注解时产生问题。使用空格也使得代码对齐更轻松。

2.5. 关键字与 True/False/Null

PHP 的 关键字 必须 使用小写形式。

PHP 的常量 true, false, 还有 null 必须 使用小写形式。

3. 命名空间和使用声明

namespace 声明之后 必须 存在一个空行。

所有的 use 声明 必须 位于 namespace 声明之后。

每条 use 声明 必须 只有一个 use 关键字。

use 语句块之后 必须 存在一个空行。

例如:



【本文地址】

公司简介

联系我们

今日新闻

    推荐新闻

    专题文章
      CopyRight 2018-2019 实验室设备网 版权所有