代码风格规范

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

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

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

关键词 “必须”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、
“将会”("SHALL")、“不会”("SHALL NOT")、“应该”("SHOULD")、“不该”("SHOULD NOT")、
“推荐”("RECOMMENDED")、“可以”("MAY")和”可选“("OPTIONAL")的详细描述可参见 [RFC 2119][] 。

1. 概览

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

  • 代码必须使用4个空格符而不是 tab键 进行缩进。

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

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

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

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

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

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

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

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

1.1. 例子

以下例子程序简单地展示了以上大部分规范:

update: 因下面程序的<?php标记影响样式故删除,请阅读的时候自动加上

  1. namespace Vendor\Package;
  2.  
  3. use FooInterface;
  4. use BarClass as Bar;
  5. use OtherVendor\OtherPackage\BazClass;
  6.  
  7. class Foo extends Bar implements FooInterface
  8. {
  9. public function sampleFunction($a, $b = null)
  10. {
  11. if ($a === $b) {
  12. bar();
  13. } elseif ($a > $b) {
  14. $foo->bar($arg1);
  15. } else {
  16. BazClass::bar($arg2, $arg3);
  17. }
  18. }
  19.  
  20. final public static function bar()
  21. {
  22. // method body
  23. }
  24. }

2. 通则

2.1 基本编码准则

代码必须符合 PSR-1 中的所有规范。

2.2 文件

所有PHP文件必须使用Unix LF (linefeed)作为行的结束符。

所有PHP文件必须以一个空白行作为结束。

纯PHP代码文件必须省略最后的 ?> 结束标签。

2.3. 行

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

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

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

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

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

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

2.4. 缩进

代码必须使用4个空格符的缩进,一定不能用 tab键 。

备注: 使用空格而不是tab键缩进的好处在于,
避免在比较代码差异、打补丁、重阅代码以及注释时产生混淆。
并且,使用空格缩进,让对齐变得更方便。

2.5. 关键字 以及 True/False/Null

PHP所有 关键字必须全部小写。

常量 true 、false 和 null 也必须全部小写。

3. namespace 以及 use 声明

namespace 声明后 必须 插入一个空白行。

所有 use 必须 在 namespace 后声明。

每条 use 声明语句 必须 只有一个 use 关键词。

use 声明语句块后 必须 要有一个空白行。

例如:

  1. <?php
  2. namespace Vendor\Package;
  3.  
  4. use FooClass;
  5. use BarClass as Bar;
  6. use OtherVendor\OtherPackage\BazClass;
  7.  
  8. // ... additional PHP code ...

4. 类、属性和方法

此处的“类”泛指所有的class类、接口以及traits可复用代码块。

4.1. 扩展与继承

关键词 extends 和 implements必须写在类名称的同一行。

类的开始花括号必须独占一行,结束花括号也必须在类主体后独占一行。

  1. <?php
  2. namespace Vendor\Package;
  3.  
  4. use FooClass;
  5. use BarClass as Bar;
  6. use OtherVendor\OtherPackage\BazClass;
  7.  
  8. class ClassName extends ParentClass implements \ArrayAccess, \Countable
  9. {
  10. // constants, properties, methods
  11. }

implements 的继承列表也可以分成多行,这样的话,每个继承接口名称都必须分开独立成行,包括第一个。

  1. <?php
  2. namespace Vendor\Package;
  3.  
  4. use FooClass;
  5. use BarClass as Bar;
  6. use OtherVendor\OtherPackage\BazClass;
  7.  
  8. class ClassName extends ParentClass implements
  9. \ArrayAccess,
  10. \Countable,
  11. \Serializable
  12. {
  13. // constants, properties, methods
  14. }

4.2. 属性

每个属性都必须添加访问修饰符。

一定不可使用关键字 var 声明一个属性。

每条语句一定不可定义超过一个属性。

不要使用下划线作为前缀,来区分属性是 protected 或 private。

以下是属性声明的一个范例:

  1. <?php
  2. namespace Vendor\Package;
  3.  
  4. class ClassName
  5. {
  6. public $foo = null;
  7. }

4.3. 方法

所有方法都必须添加访问修饰符。

不要使用下划线作为前缀,来区分方法是 protected 或 private。

方法名称后一定不能有空格符,其开始花括号必须独占一行,结束花括号也必须在方法主体后单独成一行。参数左括号后和右括号前一定不能有空格。

一个标准的方法声明可参照以下范例,留意其括号、逗号、空格以及花括号的位置。

  1. <?php
  2. namespace Vendor\Package;
  3.  
  4. class ClassName
  5. {
  6. public function fooBarBaz($arg1, &$arg2, $arg3 = [])
  7. {
  8. // method body
  9. }
  10. }

4.4. 方法的参数

参数列表中,每个参数后面必须要有一个空格,而前面一定不能有空格。

有默认值的参数,必须放到参数列表的末尾。

  1. <?php
  2. namespace Vendor\Package;
  3.  
  4. class ClassName
  5. {
  6. public function foo($arg1, &$arg2, $arg3 = [])
  7. {
  8. // method body
  9. }
  10. }

参数列表可以分列成多行,这样,包括第一个参数在内的每个参数都必须单独成行。

拆分成多行的参数列表后,结束括号以及方法开始花括号 必须 写在同一行,中间用一个空格分隔。

  1. <?php
  2. namespace Vendor\Package;
  3.  
  4. class ClassName
  5. {
  6. public function aVeryLongMethodName(
  7. ClassTypeHint $arg1,
  8. &$arg2,
  9. array $arg3 = []
  10. ) {
  11. // method body
  12. }
  13. }

4.5. abstract 、 final 、 以及 static

需要添加 abstract 或 final 声明时, 必须写在访问修饰符前,而 static 则必须写在其后。

  1. <?php
  2. namespace Vendor\Package;
  3.  
  4. abstract class ClassName
  5. {
  6. protected static $foo;
  7.  
  8. abstract protected function zim();
  9.  
  10. final public static function bar()
  11. {
  12. // method body
  13. }
  14. }

4.6. 方法及函数调用

方法及函数调用时,方法名或函数名与参数左括号之间一定不能有空格,参数右括号前也 一定不能有空格。每个参数前一定不能有空格,但其后必须有一个空格。

  1. <?php
  2. bar();
  3. $foo->bar($arg1);
  4. Foo::bar($arg2, $arg3);

参数可以分列成多行,此时包括第一个参数在内的每个参数都必须单独成行。

  1. <?php
  2. $foo->bar(
  3. $longArgument,
  4. $longerArgument,
  5. $muchLongerArgument
  6. );

5. 控制结构

控制结构的基本规范如下:

  • 控制结构关键词后必须有一个空格。
  • 左括号 ( 后一定不能有空格。
  • 右括号 ) 前也一定不能有空格。
  • 右括号 ) 与开始花括号 { 间一定有一个空格。
  • 结构体主体一定要有一次缩进。
  • 结束花括号 } 一定在结构体主体后单独成行。

每个结构体的主体都必须被包含在成对的花括号之中,
这能让结构体更加结构话,以及减少加入新行时,出错的可能性。

5.1. if 、 elseif 和 else

标准的 if 结构如下代码所示,留意 括号、空格以及花括号的位置,
注意 else 和 elseif 都与前面的结束花括号在同一行。

  1. <?php
  2. if ($expr1) {
  3. // if body
  4. } elseif ($expr2) {
  5. // elseif body
  6. } else {
  7. // else body;
  8. }

应该使用关键词 elseif 代替所有 else if ,以使得所有的控制关键字都像是单独的一个词。

5.2. switch 和 case

标准的 switch 结构如下代码所示,留意括号、空格以及花括号的位置。
case 语句必须相对 switch 进行一次缩进,而 break 语句以及 case 内的其它语句都 必须 相对 case 进行一次缩进。
如果存在非空的 case 直穿语句,主体里必须有类似 // no break 的注释。

  1. <?php
  2. switch ($expr) {
  3. case 0:
  4. echo 'First case, with a break';
  5. break;
  6. case 1:
  7. echo 'Second case, which falls through';
  8. // no break
  9. case 2:
  10. case 3:
  11. case 4:
  12. echo 'Third case, return instead of break';
  13. return;
  14. default:
  15. echo 'Default case';
  16. break;
  17. }

5.3. while 和 do while

一个规范的 while 语句应该如下所示,注意其 括号、空格以及花括号的位置。

  1. <?php
  2. while ($expr) {
  3. // structure body
  4. }

标准的 do while 语句如下所示,同样的,注意其 括号、空格以及花括号的位置。

  1. <?php
  2. do {
  3. // structure body;
  4. } while ($expr);

5.4. for

标准的 for 语句如下所示,注意其 括号、空格以及花括号的位置。

  1. <?php
  2. for ($i = 0; $i < 10; $i++) {
  3. // for body
  4. }

5.5. foreach

标准的 foreach 语句如下所示,注意其 括号、空格以及花括号的位置。

  1. <?php
  2. foreach ($iterable as $key => $value) {
  3. // foreach body
  4. }

5.6. trycatch

标准的 try catch 语句如下所示,注意其 括号、空格以及花括号的位置。

  1. <?php
  2. try {
  3. // try body
  4. } catch (FirstExceptionType $e) {
  5. // catch body
  6. } catch (OtherExceptionType $e) {
  7. // catch body
  8. }

6. 闭包

闭包声明时,关键词 function 后以及关键词 use 的前后都必须要有一个空格。

开始花括号必须写在声明的同一行,结束花括号必须紧跟主体结束的下一行。

参数列表和变量列表的左括号后以及右括号前,必须不能有空格。

参数和变量列表中,逗号前必须不能有空格,而逗号后必须要有空格。

闭包中有默认值的参数必须放到列表的后面。

标准的闭包声明语句如下所示,注意其 括号、逗号、空格以及花括号的位置。

  1. <?php
  2. $closureWithArgs = function ($arg1, $arg2) {
  3. // body
  4. };
  5.  
  6. $closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
  7. // body
  8. };

参数列表以及变量列表可以分成多行,这样,包括第一个在内的每个参数或变量都必须单独成行,而列表的右括号与闭包的开始花括号必须放在同一行。

以下几个例子,包含了参数和变量列表被分成多行的多情况。

  1. <?php
  2. $longArgs_noVars = function (
  3. $longArgument,
  4. $longerArgument,
  5. $muchLongerArgument
  6. ) {
  7. // body
  8. };
  9.  
  10. $noArgs_longVars = function () use (
  11. $longVar1,
  12. $longerVar2,
  13. $muchLongerVar3
  14. ) {
  15. // body
  16. };
  17.  
  18. $longArgs_longVars = function (
  19. $longArgument,
  20. $longerArgument,
  21. $muchLongerArgument
  22. ) use (
  23. $longVar1,
  24. $longerVar2,
  25. $muchLongerVar3
  26. ) {
  27. // body
  28. };
  29.  
  30. $longArgs_shortVars = function (
  31. $longArgument,
  32. $longerArgument,
  33. $muchLongerArgument
  34. ) use ($var1) {
  35. // body
  36. };
  37.  
  38. $shortArgs_longVars = function ($arg) use (
  39. $longVar1,
  40. $longerVar2,
  41. $muchLongerVar3
  42. ) {
  43. // body
  44. };
  45. 注意,闭包被直接用作函数或方法调用的参数时,以上规则仍然适用。
  46.  
  47. <?php
  48. $foo->bar(
  49. $arg1,
  50. function ($arg2) use ($var1) {
  51. // body
  52. },
  53. $arg3
  54. );

7. 总结

以上规范难免有疏忽,其中包括但不仅限于:

  • 全局变量和常量的定义

  • 函数的定义

  • 操作符和赋值

  • 行内对齐

  • 注释和文档描述块

  • 类名的前缀及后缀

  • 最佳实践

PHP PSR-2 代码风格规范的更多相关文章

  1. 【PSR规范专题(3)】PSR-2 代码风格规范

    [PSR规范专题(3)]PSR-2 代码风格规范 标签(空格分隔): PHP 转载自:https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-cod ...

  2. PHP PSR-2 代码风格规范 (中文版)

    代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展. 本规范希望通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 当多名程序员在多个项目中合 ...

  3. PSR-2 代码风格规范

    https://blog.csdn.net/qq_28602957/article/details/52248239 这篇规范是PSR-1(基本代码规范)的扩展和继承. 本规通过制定一系列规范化PHP ...

  4. Python 代码风格规范(Google)

    Python风格规范 分号 tip 不要在行尾加分号, 也不要用分号将两条命令放在同一行. 行长度 tip 每行不超过80个字符 例外: 长的导入模块语句 注释里的URL 不要使用反斜杠连接行. Py ...

  5. .net 代码风格规范

    声明:内容非原创,转自张子阳博客. 对于为什么是转载,唯一原因就是这东西居然比我整理的好,直接用得了. 1. C# 代码风格要求 1.1注释 类型.属性.事件.方法.方法参数,根据需要添加注释. 如果 ...

  6. .Net 项目代码风格规范

    最近没啥时间自己状态也不是很好,公司的事情忙,自己也有一些事情要处理,所以好久没有写博客了.利用公司午休时间写一写,以下是参考了一些资料,整理出来,共勉之. 代码风格没有正确与否,重要的是整齐划一,清 ...

  7. PHP 权威代码风格规范

    1.常规 尽量统一ide 比如phpstream 配置文件(Settings → Code Style → PHP → Set from... → Predefined Style → PSR1/PS ...

  8. Google的代码风格规范,各种语言都很全

    https://code.google.com/p/google-styleguide/

  9. python代码风格规范

    类注释模板: :: class AnotherClass: """ 类注释 """ def method(self, arg1, arg2, ...

随机推荐

  1. 详解Cisco ACS AAA认证-1(转)

    转自:http://www.360doc.com/content/12/0611/17/8797027_217495523.shtml作者:luobo2012 近来,有些同学会问到关于AAA认证的问题 ...

  2. one_day_one_linuxCmd---scp命令

    <坚持每天学习一个 linux 命令,今天我们来学习 scp 命令> scp 命令主要用在不同的 linux 系统之间 copy 文件,基于 ssh 登录,是一种安全的复制 scp 命令的 ...

  3. PAT Basic 1013 数素数 (20) [数学问题-素数]

    题目 令Pi表示第i个素数.现任给两个正整数M <= N <= 10^4,请输出PM到PN的所有素数. 输⼊格式: 输⼊在⼀⾏中给出M和N,其间以空格分隔. 输出格式: 输出从PM到PN的 ...

  4. python编程:从入门到实践----第五章:if语句>练习

    5-1 条件测试 :编写一系列条件测试:将每个测试以及你对其结果的预测和实际结果都打印出来. a. 详细研究实际结果,直到你明白了它为何为True 或False b. 创建至少2个测试,且其中结果分别 ...

  5. Go-开发环境搭建

    02-开发环境搭建   目录 一 下载地址 二 安装 Linux安装 Windows安装 Mac安装 三 测试安装 四 命令介绍 基本介绍 build 和 run 命令 get 命令 一 下载地址 安 ...

  6. win10环境下pyinstaller打包pytorch遇到的问题及解决方案

    pytorch-python源码生成windows的应用程序(.exe),报错OSError: could not get source code Failed to execute script h ...

  7. object detection模型转换成TensorFlow Lite,在Android应用

    环境 tensorflow = 1.12.0 bazel = 0.18.1 ubuntu = 16.04 python = 3.6.2 安装 bazel (0.18.1) 如果tensorflow是1 ...

  8. gcc -S xx

    编译器的核心任务是把C程序翻译成机器的汇编语言(assembly language).汇编语言是人类可以阅读的编程语言,也是相当接近实际机器码的语言.由此导致每种 CPU 架构都有不同的汇编语言. 实 ...

  9. 【YOLO学习】召回率(Recall),精确率(Precision),平均正确率(Average_precision(AP) ),交除并(Intersection-over-Union(IoU))

    摘要 在训练YOLO v2的过程中,系统会显示出一些评价训练效果的值,如Recall,IoU等等.为了怕以后忘了,现在把自己对这几种度量方式的理解记录一下. 这一文章首先假设一个测试集,然后围绕这一测 ...

  10. [SDOI2010]魔法猪学院(k短路)

    A*板子题.我的code只能在luogu上过,bzoj上RE/MLE不清楚为啥. 蒟蒻到AFO前2个月不到的时间才学A*,A*其实就是bfs过程中进行剪支删除没必要的搜索.然后其实上这样剪支即可:如果 ...