PHP 代码规范 (Rohn Style)

PHP 代码文件

• 必须以<?php 开头，不能用<? 以免配置为short_open_tag = off 时造成出错；
• 必须以不带BOM的 UTF-8 编码；
• 纯PHP代码的文件关闭标签?>必须省略；

命名规则

• 类 -- 必须按照大写开头的驼峰式命名；
  class HelloWorld
• 方法 -- 必须按照小写开头的驼峰式命名；
  public function helloFunction()
• 属性 -- 必须以小写开头的驼峰式命名；
  $helloAttribute
• 常量 -- 所有字母都必须大写，词间以下划线分隔;
  const HELLO_WORLD = 'hello world'
• 私有 -- 属性和方法都必须以 _ 开头;
  private function _helloFunction()
private $_helloWorld
• 参数&临时变量 -- 字母全小写，词间以下划线分割；
  $hello_world

布局

• 在namespace声明下面必须有一个空行，并且use声明代码块下面也必须有一个空行;
• 类和方法的左花括号必须放到下一行，右花括号必须放在主体的下一行；

class HelloWord
{
        function __construct()
        {
                echo 'hello world';
        }
}

• 控制结构：
• 关键词有()的时候，()左右两端外界各留一个空格，方法和函数不可有；
• 左花括号必须放在同一行，右花括号必须放在控制主体的下一行；
• 右花括号必须与控制结构关键词左侧对齐；

if ($hello_world == true) {//()两端外界都有一个空格
      //控制主体
}//与if对齐

function helloWorld (){} //()前面的空格

• 参数列表：
• ,之后要有一个空格；
• 方法中有默认值的参数必须放在参数列表的最后面；
• 参数列表可以被分为多个有一次缩进的多个后续行。如果这么做，列表的第一项必须放在下一行，并且每行必须只放一个参数；

function helloWorld($arg1, &$arg2, $arg3='test'){}

function multLines(
      $arg1,
      &$arg2,
      $arg3='test'
){}

其他

• 一个文件中最多只有一个类；
• 一行代码的长度尽量控制在120个字符以内；
• 一个class不要超过500行有效代码；
• PHP关键词true, false和null必须使用小写；
• 类方法中不要出现$_SERVER、$_GET、$_POST等，要通过形参传递到类方法。

---

更多细节可参考 PSR