PSR编码规范

代码规范
代码规范使用说明
代码规范是一个PHP开发工程师必须遵循的基本开发准则,为了提升代码质量,成为一个合格的软件开发工程师,代码规范作为考试标准之一,列为默认评分标准。
代码规范分为四部分:PSR-1基本代码规范、PSR-2代码风格规范、PSR-3日志接口规范、PSR-4 Autoloader,具体参看每一部分规范的详细内容项。
在考试阅卷过程中,严格按照代码规范进行评分,评分则采用减分制,未遵守对应规范则扣除对应分值,具体参看每一项规范对应的分值。

PSR-1 基本代码规范
本篇规范制定了代码基本元素的相关标准,以确保共享的PHP代码间具有较高程度的技术互通性。
关键词 “必须”(MUST)、“一定不可、一定不能”(MUST NOT)、“需要”(REQUIRED)、“将会”(SHALL)、“不会”(SHALL NOT)、“应该”(SHOULD)、“不该”(SHOULD NOT)、“推荐”(RECOMMENDED)、“可以”(MAY)和“可选”(OPTIONAL)
PHP代码文件必须以<?php 或<?= 标签开头。
PHP代码文件必须以不带BOM的UTF-8编码。
PHP代码中应该只定义类、函数、常量等声明,或其他会产生从属效应的操作(生成文件输出以及修改.ini配置文件等),二者只能选其一。
命名空间以及类必须符合PSR的自动加载规范:PSR-4。
类的命名必须遵循StudlyCaps大写开头的驼峰命名规范。
类中的常量所有字母都必须大写,单词间用下划线分隔。
方法名称必须符合camelCase式的小写开头驼峰命名规范。
PSR-2 代码风格规范
本篇规范是PSR-1基本代码规范的额继承与扩展。本规范希望通过制定一系列规范化PHP代码规范,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便。当多名程序员在多个项目中合作时,就需要一个共同的编码规范,而本文中的风格规范源自于多个不同项目代码风格的共同特性。因此,本规范的价值在于我们都遵循这个编码风格,而不是在于它本身。
代码必须使用四个空格符而不是tab键进行缩进。
每行的字符数应该软性保持在80个内,理论上不可多于120个,但一定不能由硬性限制。
每个namespace命名空间声明语句和use声明语句块后面,必须插入一个空白行。
类的开始花名号({}必须在函数声明后自成一行,结束花名号())也必须在函数主体后自成一行。
类的属性和方法必须添加访问修饰符(private protected以及public),abstract以及final必须声明在访问修饰符之前,而static必须声明在访问修饰符之后。
控制结构的关键字后必须要有一个空格符,而调用方法或函数时则一定不能有。
控制结构的开始花括号({}必须写在声明的同一行,而结束花括号())必须写在主体后自成一行。
控制结构的开始左括号后和结束右括号前,都一定不能有空格符。
PSR-3日志接口规范
本规范的主要目的,是为了让日志类库以简单通用的方式,通过接收一个Psr\Log\LoggerInterface对象,来记录日志信息。框架以及CMS内容管理系统如有需要,可以对此接口进行扩展,但须遵循本规范,才能保证使用第三方的类库文件时,日志接口仍能正常对接。
LoggerInterface 接口对外定义了八个方法,分别用来记录RFC 5424中定义的八个登记日志:debug、info、notice、warning、error、critical、alert以及emergency。
第九个方法-log,其第一个参数为记录的等级,可使用一个预先定义的等级常量作为参数来调用此方法,必须与直接调用以上八个方法具有相同的效果。如果传入的等级常量参数没有预先定义,就必须抛出Psr\Log\InvalidArgumentException类型的异常,在不确定的情况下,使用者不该使用为支持的等级常量来调用此方法。
PSR-4 Autoloader
本PSR是关于由文件路径自动载入对应的类的相关规范,本规范是可互操作的。可以作为任一自动载入规范的补充,其中包括PSR-0,此外,本PSR还包括自动载入的类对应的文件存放路径规范。
此处的“类”泛指所有的class类、接口、traits可复用代码块以及其他类似结构。
一个完整的类名需要具有以下结构:<命名空间>(<子命名空间>)*<类名>。
完整的类名必须要有一个顶级命名空间,被称为“Vendor namespace”。
完整的类名可以有一个或多个子命名空间。
完整的类名必须有一个最终的类名。
完整的类名中任意一部分中的下划线都是没有特殊意义的。
所有类名都必须是大小写敏感的。
当根据完整的类名载入相应的文件。
完整的类名中,去掉最前面的命名空间分隔符,前面连续的一个或多个命名空间和子命名空间,作为“命名空间前缀”,其必须与至少一个“文件基目录”相对应。
紧接命名空间前缀后的子命名空间必须与相对应的“文件基目录”相匹配,其中的命名空间分隔符作为目录分割符。
末尾的类名必须与对应的.php为后缀的文件同名。
自动加载器(autoloader)的实现一定不能抛出异常,一定不能触发任一级别的错误信息以及不应该有返回值。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值