统一的代码规范,有助于培养良好的编码习惯,团队成员间的代码交流更加简单。而对于PHP来说,PSR无疑是目前最好的选择。
PSR,即PHP Standard Recommendations,是目前最流行的PHP相关规范集合。
截止目前,PSR官方给出了19中规范,在阅读规范时需要注意规范的状态。现有的状态分为:
- Deprecated
不在推荐了,因为在后续版本中可能被废弃。 - Accepted
被PSR组织接受,并且正在使用的规范,这部分正式我们应该花时间去学习的规范。 - Abandoned
很明显,这部分规范已经被废弃。 - Review
我的理解是这部分的规范正在被评审。 - Draft
很明显,这部分规范正处于起草阶段。
那么从这篇文章起,就会逐一简述每个规范的主要内容,以便在工作中尽快的上手这些规范,融入PHP大的标准之中。
PSR-1
这是最基础的一部分编码规范,它的主要内容简述为:
1. 文件编码统一使用无BOM的UTF-8;
2. 文件以<?php
或者<?
开头;
3. 必须使用一种自动加载策略(PSR-0或者PSR-4);
4. 一个文件中应该包含声明行代码或者具有边际效应的代码;
5. 类名应采用首字母大写的方式,例如StudlyCaps;
6. 类的常量应该全部大写,并且以_分隔;
7. 类的变量原则上不做要求,但是在一定范围(例如项目/包)内应该保持一致;
8. 方法名应该使用驼峰法命名;