之前的一篇文章是对psr-1的基本介绍
接下来是psr-2 编码风格规范,它是 psr-1 基本代码规范的继承与扩展。
psr-1 和psr-2是php开发中基本的编码规范,大家其实都可以参考学习下,虽然说每个开发者都有自己熟悉的一套开发规范,但是我觉得还是根据行业标准来编写我们的代码,毕竟标准都是经过验证的了。希望能对php开发者有帮助吧。
以下例子程序简单地展示了以上大部分规范:
<?php namespace vendor\package; use foointerface; use barclass as bar; use othervendor\otherpackage\bazclass; class foo extends bar implements foointerface { public function samplefunction($a, $b = null) { if ($a === $b) { bar(); } elseif ($a > $b) { $foo->bar($arg1); } else { bazclass::bar($arg2, $arg3); } } final public static function bar() { // 方法的内容 } }
代码 必须 符合 [psr-1]() 中的所有规范。
所有php文件 必须 使用 unix lf (linefeed) 作为行的结束符。
所有php文件 必须 以一个空白行作为结束。
纯php代码文件 必须 省略最后的 ?> 结束标签。
行的长度 一定不可 有硬性的约束。
软性的长度约束 必须 要限制在 120 个字符以内,若超过此长度,带代码规范检查的编辑器 必须 要发出警告,不过 一定不可 发出错误提示。
每行 不该 多于80个字符,大于80字符的行 应该 折成多行。
非空行后 一定不可 有多余的空格符。
空行 可以 使得阅读代码更加方便以及有助于代码的分块。
每行 一定不可 存在多于一条语句。
代码 必须 使用4个空格符的缩进,一定不可 用 tab键。
备注:使用空格而不是「tab键缩进」的好处在于,
避免在比较代码差异、打补丁、重阅代码以及注释时产生混淆。
并且,使用空格缩进,让对齐变得更方便。
php所有 关键字 必须 全部小写。
常量 true 、false 和 null 也 必须 全部小写。
namespace 声明后 必须 插入一个空白行。
所有 use 必须 在 namespace 后声明。
每条 use 声明语句 必须 只有一个 use 关键词。
use 声明语句块后 必须 要有一个空白行。
例如:
<?php namespace vendor\package; use fooclass; use barclass as bar; use othervendor\otherpackage\bazclass;
此处的「类」泛指所有的「class类」、「接口」以及「traits 可复用代码块」。
关键词 extends 和 implements 必须 写在类名称的同一行。
类的开始花括号 必须 独占一行,结束花括号也 必须 在类主体后独占一行。
<?php namespace vendor\package; use fooclass; use barclass as bar; use othervendor\otherpackage\bazclass; class classname extends parentclass implements \arrayaccess, \countable { // 这里面是常量、属性、类方法 }
implements 的继承列表也 可以 分成多行,这样的话,每个继承接口名称都 必须 分开独立成行,包括第一个。
<?php namespace vendor\package; use fooclass; use barclass as bar; use othervendor\otherpackage\bazclass; class classname extends parentclass implements \arrayaccess, \countable, \serializable { // 这里面是常量、属性、类方法 }
每个属性都 必须 添加访问修饰符。
一定不可 使用关键字 var 声明一个属性。
每条语句 一定不可 定义超过一个属性。
不该 使用下划线作为前缀,来区分属性是 protected 或 private。
以下是属性声明的一个范例:
<?php namespace vendor\package; class classname { public $foo = null; }
所有方法都 必须 添加访问修饰符。
不该 使用下划线作为前缀,来区分方法是 protected 或 private。
方法名称后 一定不可 有空格符,其开始花括号 必须 独占一行,结束花括号也 必须 在方法主体后单独成一行。参数左括号后和右括号前 一定不可 有空格。
一个标准的方法声明可参照以下范例,留意其括号、逗号、空格以及花括号的位置。
<?php namespace vendor\package; class classname { public function foobarbaz($arg1, &$arg2, $arg3 = []) { // method body } }
参数列表中,每个逗号后面 必须 要有一个空格,而逗号前面 一定不可 有空格。
有默认值的参数,必须 放到参数列表的末尾。
<?php namespace vendor\package; class classname { public function foo($arg1, &$arg2, $arg3 = []) { // method body } }
参数列表 可以 分列成多行,这样,包括第一个参数在内的每个参数都 必须 单独成行。
拆分成多行的参数列表后,结束括号以及方法开始花括号 必须 写在同一行,中间用一个空格分隔。
<?php namespace vendor\package; class classname { public function averylongmethodname( classtypehint $arg1, &$arg2, array $arg3 = [] ) { // 方法的内容 } }
需要添加 abstract 或 final 声明时,必须 写在访问修饰符前,而 static 则 必须 写在其后。
<?php namespace vendor\package; abstract class classname { protected static $foo; abstract protected function zim(); final public static function bar() { // method body } }
方法及函数调用时,方法名或函数名与参数左括号之间 一定不可 有空格,参数右括号前也 一定不可 有空格。每个参数前 一定不可 有空格,但其后 必须 有一个空格。
<?php bar(); $foo->bar($arg1); foo::bar($arg2, $arg3); 参数 可以 分列成多行,此时包括第一个参数在内的每个参数都 必须 单独成行。 <?php $foo->bar( $longargument, $longerargument, $muchlongerargument );
控制结构的基本规范如下:
每个结构体的主体都 必须 被包含在成对的花括号之中,
这能让结构体更加结构话,以及减少加入新行时,出错的可能性。
标准的 if 结构如下代码所示,请留意「括号」、「空格」以及「花括号」的位置,
注意 else 和 elseif 都与前面的结束花括号在同一行。
<?php if ($expr1) { // if body } elseif ($expr2) { // elseif body } else { // else body; }
应该 使用关键词 elseif 代替所有 else if ,以使得所有的控制关键字都像是单独的一个词。
标准的 switch 结构如下代码所示,留意括号、空格以及花括号的位置。
case 语句 必须 相对 switch 进行一次缩进,而 break 语句以及 case 内的其它语句都 必须 相对 case进行一次缩进。
如果存在非空的 case 直穿语句,主体里 必须 有类似 // no break 的注释。
<?php switch ($expr) { case 0: echo 'first case, with a break'; break; case 1: echo 'second case, which falls through'; // no break case 2: case 3: case 4: echo 'third case, return instead of break'; return; default: echo 'default case'; break; }
一个规范的 while 语句应该如下所示,注意其「括号」、「空格」以及「花括号」的位置。
<?php while ($expr) { // structure body }
标准的 do while 语句如下所示,同样的,注意其「括号」、「空格」以及「花括号」的位置。
<?php do { // structure body; } while ($expr);
标准的 for 语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。
<?php for ($i = 0; $i < 10; $i++) { // for body }
标准的 foreach 语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。
<?php foreach ($iterable as $key => $value) { // foreach body }
标准的 try catch 语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。
<?php try { // try body } catch (firstexceptiontype $e) { // catch body } catch (otherexceptiontype $e) { // catch body }
闭包声明时,关键词 function 后以及关键词 use 的前后都 必须 要有一个空格。
开始花括号 必须 写在声明的同一行,结束花括号 必须 紧跟主体结束的下一行。
参数列表和变量列表的左括号后以及右括号前,一定不可 有空格。
参数和变量列表中,逗号前 一定不可 有空格,而逗号后 必须 要有空格。
闭包中有默认值的参数 必须 放到列表的后面。
标准的闭包声明语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。
<?php $closurewithargs = function ($arg1, $arg2) { // body }; $closurewithargsandvars = function ($arg1, $arg2) use ($var1, $var2) { // body };
参数列表以及变量列表 可以 分成多行,这样,包括第一个在内的每个参数或变量都 必须 单独成行,而列表的右括号与闭包的开始花括号 必须 放在同一行。
以下几个例子,包含了参数和变量列表被分成多行的多情况。
<?php $longargs_novars = function ( $longargument, $longerargument, $muchlongerargument ) { // body }; $noargs_longvars = function () use ( $longvar1, $longervar2, $muchlongervar3 ) { // body }; $longargs_longvars = function ( $longargument, $longerargument, $muchlongerargument ) use ( $longvar1, $longervar2, $muchlongervar3 ) { // body }; $longargs_shortvars = function ( $longargument, $longerargument, $muchlongerargument ) use ($var1) { // body }; $shortargs_longvars = function ($arg) use ( $longvar1, $longervar2, $muchlongervar3 ) { // body };
注意,闭包被直接用作函数或方法调用的参数时,以上规则仍然适用。
<?php $foo->bar( $arg1, function ($arg2) use ($var1) { // body }, $arg3 );
参考资料:
https://psr.phphub.org/
------------------------------------------------------------------------------
如对本文有疑问, 点击进行留言回复!!
php 使用 yansongda/pay 进行微信,支付宝支付
Codeforces Round #658 (Div. 2) (C1、C2)
van-uploader + thinkphp6.0 图片上传
网友评论