开发规范

未分类

文件

1. PHP代码必须使用 长标签

2. PHP代码必须且只可使用不带BOM的UTF-8编码。

3. 一份 PHP 文件中 应该 要不就只定义新的声明，如类、函数或常量等不产生 副作用 的操作，要不就只书写会产生 副作用 的逻辑操作，但 不该 同时具有两者

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

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

6. 代码 必须 使用4个空格符的缩进，一定不可 用 tab键。

7. 每行 不该 多于80个字符，大于80字符的行 应该 折成多行

8. PHP所有 关键字 必须 全部小写。常量 true 、false 和 null 也 必须 全部小写。

类

命名空间和use

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

2. 所有 use 必须 在 namespace 后声明。

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

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

成员属性

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

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

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

4. 类的属性命名可以遵循 大写开头的驼峰式 ($StudlyCaps)

5. 不该 使用下划线作为前缀，来区分属性是 protected 或 private。

成员方法

1. 方法名称 必须 符合 camelCase() 式的小写开头驼峰命名规范

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

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

4. 不该 使用下划线作为前缀，来区分方法是 protected 或 private

5. 参数列表中，每个逗号后面 必须 要有一个空格，而逗号前面 一定不可 有空格。

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

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

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

控制结构

if 、elseif 和 else

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

if ($expr1) {
    // if body
} elseif ($expr2) {
    // elseif body
} else {
    // else body;
}

switch 和 case

标准的 switch 结构如下代码所示，留意括号、空格以及花括号的位置。 case 语句 必须 相对 switch 进行一次缩进，而 break 语句以及 case 内的其它语句都 必须 相对 case 进行一次缩进。

如果存在非空的 case 直穿语句，主体里 必须 有类似 // no break 的注释。

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 和 do while

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

do {
    // structure body;
} while ($expr);

for

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

for ($i = 0; $i < 10; $i++) {
    // for body
}

foreach

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

foreach ($iterable as $key => $value) {
    // foreach body
}

try, catch

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

<?php
try {
    // try body
} catch (FirstExceptionType $e) {
    // catch body
} catch (OtherExceptionType $e) {
    // catch body
}