小米 PHP 编码规范及建议

| 选择喜欢的代码风格  

编码规范


PHP代码文件必须以 <?php 标签开始。

<?php //开头

// 不结尾

PHP代码文件必须以不带BOM的UTF-8编码

#Sublime, setting 增加
"show_encoding" : true

每行的字符数不超过 80 个字符

#Sublime
"word_wrap": true,
"wrap_width": 80,

tap键4个空格

#Sublime
"tab_size": 4,

PHP代码中应该只定义 类(trait)/函数/常量/ 其他会产生副作用的操作(如:生成文件输出以及修改 .ini 配置文件等),只能选其一。

#a.php
class A
{

}

#b.php
function demo()
{

}

#c.php
define('A', value);

#d.php
ini_set('some_vars', value);

类/trait/Interface 的命名必须遵循 StudlyCaps 大驼峰命名规范

class StudlyCaps
{

}

trait StudlyCaps
{

}

Interface StudlyCaps
{

}

类中的常量所有字母都必须大写,单词间用下划线分隔.

define('FOO_BAR', 'something more');

const FOO_BAR = value;

方法(类/trait中) 名称必须符合 camelCase 式的小驼峰命名规范。

class StudlyCaps
{
    public function studlyCaps()
    {
        // coding...
    }
}

函数名称必须符合 snake_case 式的下划线式命名规范

function snake_case()
{
    // coding...
}

私有的(private)方法(类/trait中)名称必须符合 _camelCase 式的前置下划线小写开头驼峰命名规范。

class StudlyCaps
{
    private function _studlyCaps()
    {
        // coding...
    }
}

方法名称 第一个单词 为动词

class StudlyCaps
{
    public function doSomething()
    {
        // coding...
    }
}

变量 必须符合 camelCase 式的小驼峰命名规范。

class StudlyCaps
{
    public function doSomething()
    {
        $someVariable = 'demo';
        // coding...
    }
}

方法/函数 多参数时,之间要有1个空格

$a = $b + $c;
$a = $b . $c;

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

namespace Standard;
// 空一行
use Test\TestClass;//use引入类
// 空一行

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

class StudlyCaps
{

}

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

class StudlyCaps
{
    public function studlyCaps()
    {
        // coding...
    }
}

function snake_case()
{
    // coding...
}

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

abstract class StudlyCaps
{
	abstract public function studlyCaps();

	final public static function studlyCapsOne()
	{

	}
}

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

if ($valueOne === $valueTwo) {
  // code...
}

switch ($valueThree) {
  case 'value':
    // code...
    break;

  default:
    // code...
    break;
}

do {
  // code...
} while ($valueFour <= 10);

while ($valueFive <= 10) {
  // code...
}

for ($i = 0; $i < $valueSix; $i++) {
  // code...
}

$demo = new Demo()
$demo->doSomething();

do_something();

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

if ($valueOne === $valueTwo) {
  // code...
}

switch ($valueThree) {
  case 'value':
    // code...
    break;

  default:
    // code...
    break;
}

do {
  // code...
} while ($valueFour <= 10);

while ($valueFive <= 10) {
  // code...
}

for ($i = 0; $i < $valueSix; $i++) {
  // code...
}

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

if ($valueOne === $valueTwo) {// 控制结构(右边和)左边不加空格
  // code...
}


发表评论