PHP编码规范(PSR)的简述

断了今生、忘了曾经 提交于 2019-12-02 05:06:06

PSR简介

PSR是一系列关于PHP开发的规范,一般大家遵守的是 php-fig定义的规范,中文翻译版本参考目前官方已制定的规范包括以下六份文件:

  • PSR-0 (弃用)
  • PSR-1 (基本代码规范)
  • PSR-2 (代码风格规范)
  • PSR-2补充
  • PSR-3 (日志接口规范)
  • PSR-4 (自动载入)

PSR-1 基本代码规范

概况

  • 代码文件必须以<?php<?= 标签开始
  • 代码文件必须以不带BOM头的 UTF-8 编码
  • 代码文件中应该只定义类(class)、函数(function)、常量(constants)等声明,或其他会产生从属效应 的操作(如:生成文件输出以及修改.ini配置文件等),二者只能选其一,也就是说功能唯一;
  • 命名空间以及类必须符合 PSR 的自动加载规范:PSR-4;
  • 类的命名必须遵循StudlyCaps大写开头的驼峰命名规范;
  • 类中的常量所有字母都必须大写,单词间用下划线分隔;
  • 方法名称必须符合camelCase式的小写开头驼峰命名规范;

PHP编码规范(PSR-1)

PSR-2 代码风格规范

概况

  • 代码必须遵循 PSR-1 中的编码规范 。
  • 代码必须使用4个空格符而不是tab键 进行缩进。
  • 每行的字符数应该软性保持在80个之内,理论上一定不可多于120个,但一定不能有硬性限制。
  • 每个 namespace 命名空间声明语句和 use 声明语句块后面,必须插入一个空白行。
  • 类的开始花括号({)必须写在函数声明后自成一行,结束花括号(})也必须写在函数主体后自成一行。
  • 方法的开始花括号({)必须写在函数声明后自成一行,结束花括号(})也必须写在函数主体后自成一行。
  • 类的属性和方法必须添加访问修饰符(privateprotected以及public),abstract 以及 final 必须声明在访问修饰符之前,而static必须声明在访问修饰符之后。
  • 控制结构的关键字后必须要有一个空格符,而调用方法或函数时则一定不能有。
  • 控制结构的开始花括号({)必须写在声明的同一行,而结束花括号(})必须写在主体后自成一行。
  • 控制结构的开始左括号后和结束右括号前,都一定不能有空格符。

PHP编码规范(PSR-2)

PSR-4 Autoloader

概述

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

PHP编码规范Autoloader(PSR-4)

在规定好代码规范之后,如何用工具去修改和修正代码文件呢,可以继续阅读

PHP 编码格式化工具 PHP-CS-Fixer的使用

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!