本指罗列了通用的php代码格式规则和建议,意在减少不同作者的编码风格差异带来的认知障碍。
这里的风格约定衍生自若干成员项目。指南作者们在多个项目中协作,推动了这些指导条款落地。 指南的关键在于共享,而不是规则本身。
文中涉及的关键词 “must 必须”, “must not 必须不”, “required 必需”, “shall 会”, “shall not 不会”, “should 应该”, “should not 不应该”, “recommended 推荐的”, “may 可能”, 和 “optional 可选的” 在rfc 2119 中有具体描述.
概览
代码必需遵循 “基础编码标准” psr [psr-1]。代码缩进必须使用 4 空格,而不是tab。行长度必须无硬性限制; 软性限制必须为120字符;应该少于等于80字。namespace声明后必须有一个空行,use声明后也必须有一个空行。类的{ 必须在类名的下一行, }必须在body的下一行。方法的 { 必须在方法签名的下一行,} 必须在body的下一行。所有的属性和方法都要设置可见性; abstract和 final必须在可见性之前声明;static 必须在可见性后声明。结构控制关键词后必须有一个空格; 方法和函数必须没有空格。结构控制的 { 必须在同一行,} 必须在body的下一行。 结构控制的 ( 后必须有空格, 结构控制的 ) 前必须没有空格。例子
下面是一个综合的例子,可以帮助你对规则有一个概略的认识。
$b) { $foo->bar($arg1); } else { bazclass::bar($arg2, $arg3); } } finalpublicstaticfunctionbar() {// 方法 body }}
基本规则
基本编码标准
代码必须遵循psr-1的条款。
文件
所有文件必须使用 unix lf (linefeed) 换行。所有php文件必须使用单个空行结束。只包含php的代码必须忽略php结束标记 ? >。行
行长度必须没有硬性限制。长度的软性限制必须为120字符;自动代码风格检查必须将120字设置为警告,必须不能设置为错误。行不应该超过80字符;超过这个长度的行应该切分为多个不超过80字符的行。非空行的结束必须没有尾随空格。为增强可读性,可增加空行来标志代码的关联性。每行包含的语句必须不能超过1条。缩进
代码必须使用 4 空格的缩进, 必须不用tab作为缩进。注意:只使用空格,不用tab,有助于避免diffs,patches, history和annotations的问题。使用空格也有助于对齐。
关键词(保留字) 和 true/false/null
php保留字必须小写.php常量 true, false和 null 必须小写.namespace 和 use 声明
namespace 声明之后必须有空行。所有use 声明,必须在namespace声明之后。每个声明必须单独使用一个use。use声明区之后必须有一个空行。例如:
类, 属性 和 方法
这里的“类”包括 class、interface 和 trait。
继承 和 实现
extends 和 implements 关键字必须和类名在同一行声明。
类的 { 必须独占一行; } 必须在body的下一行。
implements 多个接口时,接口列表可以被分到多行,每个子行有一个缩进。如果这么做,第一个接口必须在implements 下一行,每行只能有一个接口。
属性
所有属性都必须声明 visibility(可见性)。
var 关键字必须不能用于声明属性。
每行必须只声明一个属性。
不应该通过前缀下划线来标示protected和private的属性。
例:
方法
所有方法都必须声明可见性。
不应该通过前缀下划线来标示protected和private的方法。
声明方法时,方法名的后必须没有空格。 { 必须在同一行, } 必须在body的下一行。 (后必须没有空格,) 前必须没有空格。
一个方法声明的例子如下,注意 小括号,逗号,空格 和 花括号 的位置:
方法参数
方法的形参列表中, 每个逗号前必须没有空格。有默认值的参数必须在参数列表的最后。
参数列表可以切分为多行,每个子行要有一个缩进。如果这么做,第一个参数必须独占一行,每行只能有一个参数。
参数列表切分为多行时,右括号)和左花括号{必须在同一行,之前必须有一个空格。
abstract, final 和 static
abstract和final声明必须在可见性之前声明。
static声明必须在可见性之后。
方法和函数调用
写方法或函数调用时,方法/函数名 和 左括号( 之间,必须没有空格, 右括号 ) 之前必须没有空格。在参数列表中,逗号间必须没有逗号,每个逗号后必须有一个空格。
bar( $longargument, $longerargument, $muchlongerargument);
控制结构
控制结构通常遵循以下风格:
控制结构关键词后必须有一个空格。左括号后必须没有空格。右括号前必须没有空格。又括号和左花括号之间必须有一个空格。body必须有一层缩进。右花括号必须在body下一行。每个控制结构的body必须用花括号括起来。 即保证外观统一,又减少了添加新行时引入的错误。if, elseif, else
if 结构如下所示。注意括号、空格、花括号的位置;同时留意 else 和 elseif 与前一部分的 } 在同一行。
elseif关键字不应该被 else if 代替。
switch, case
switch结构如下所示。注意括号、空格和花括号的位置。 case 语句相对于switch必须有一个缩进, break关键字 或者其他终结性的关键字必须和case body在同一缩进层级。在非空的case body,如果没有终结性语句,必须加上注释 // no break。
while, do while
while结构如下所示。 注意括号、空格和花括号的位置。
do-while接口如下所示。 注意括号、空格和花括号的位置。
for
for 结构如下所示。 注意括号、空格和花括号的位置。
foreach
foreach 结构如下所示。 注意括号、空格和花括号的位置。
$value) { // foreach body}
try, catch
try-catch区块如下所示。 注意括号、空格和花括号的位置。
closure 闭包
声明闭包必须在function关键字后留一个空格,在use关键字前后各留一个空格。
左花括号必须在同一行, 右花括号必须在body的下一行。
参数或变量列表的左括号后 和 右括号前必须没有空格。
参数和变量列表的逗号前必须没有空格,每个逗号后必须有一个空格。
有默认值的参数必须排在最后。
闭包的声明如下所示。 注意括号,逗号,空格和花括号的位置:
参数列表和变量列表可以拆分到多行,每个子行有一层缩进。 这么做的时候,第一个列表成员必须独占一行,每行只能有一个列表成员。
参数或变量列表拆分为多行时,到了列表的末尾, 右括号 和 左花括号必须放在同一行,中间有一个空格。
例子:
tag required?
line_endings: what type of line ending is used?
static_or_visibility_first: when declaring a method, does static come first, or does the visibility come first?
control_space_parens: in a control structure expression, is there a space after the opening parenthesis and a space before the closing parenthesis? yes = if ( expr),no=if(expr).
blank_line_after_php: is there a blank line after the opening php tag?
class_method_control_brace: a summary of what line the opening braces go on for classes, methods, and control structures.
调查结果
indent_type: tab: 72: 14: 14line_length_limit_soft: ?: 2 no: 375: 480: 685: 1100: 1120: 4150: 1line_length_limit_hard: ?: 2 no: 1185: 4100: 3120: 2class_names: ?: 1 lower: 1 lower_under: 1 studly: 19class_brace_line: next: 16 same: 6constant_names: upper: 22true_false_null: lower: 19 upper: 3method_names: camel: 21 lower_under: 1method_brace_line: next: 15 same: 7control_brace_line: next: 4 same: 18control_space_after: no: 2 yes: 20always_use_control_braces: no: 3 yes: 19else_elseif_line: next: 6 same: 16case_break_indent_from_switch:0/1: 41/1: 41/2: 14function_space_after: no: 22closing_php_tag_required: no: 19 yes: 3line_endings: ?: 5 lf: 17static_or_visibility_first: ?: 5 either: 7 static: 4 visibility: 6control_space_parens: ?: 1 no: 19 yes: 2blank_line_after_php: ?: 1 no: 13 yes: 8class_method_control_brace: next/next/next: 4 next/next/same: 11 next/same/same: 1 same/same/same: 6
以上就介绍了php编码风格指南 (php-fig psr-2),包括了方面的内容,希望对php教程有兴趣的朋友有所帮助。