PHP代码规范

一、基本约定

1、源文件

(1)纯PHP代码源文件只使用 <?php 标签,省略关闭标签 ?> ;

(2)源文件中PHP代码的编码格式必须是无BOM的UTF-8格式;

(3)一个源文件只做一种类型的声明,即,这个文件专门用来声明Class, 那个文件专门用来设置配置信息,别混在一起写;

2、缩进

使用Tab键来缩进,每个Tab键长度设置为4个空格;

3、行

一行推荐的是最多写120个字符,多于这个字符就应该换行了,一般的编辑器是可以设置的。

4、关键字 和 True/False/Null

PHP的关键字,必须小写,boolean值:true,false,null 也必须小写。

下面是PHP的“关键字”,必须小写:

'__halt_compiler', 'abstract', 'and', 'array', 'as', 'break', 'callable', 'case',
 'catch', 'class', 'clone', 'const', 'continue', 'declare', 'default', 'die', 'do',
'echo', 'else','elseif', 'empty', 'enddeclare', 'endfor', 'endforeach', 'endif', 
'endswitch', 'endwhile', 'eval', 'exit', 'extends', 'final', 'for', 'foreach',
 'function', 'global', 'goto', 'if', 'implements', 'include', 'include_once',
 'instanceof', 'insteadof', 'interface', 'isset', 'list', 'namespace', 'new', 'or', 
'print', 'private', 'protected', 'public', 'require', 'require_once', 'return',
 'static', 'switch', 'throw', 'trait', 'try', 'unset', 'use', 'var', 'while', 'xor'

5、命名

(1)类名 使用大驼峰式(StudlyCaps)写法;

(2)(类的) 方法名 使用小驼峰(cameCase)写法;

(3)函数名使用 小写字母 + 下划线 写法,如 function http_send_post();

(4)变量名 使用小驼峰写法,如 $userName;

6、代码注释标签

如 函数注释、变量注释等,常用标签有 @package@var@param@return@author@todo@throws

必须遵守 phpDocument 标签规则,不要另外去创造新的标签,更多标签查看 phpDocument官网

7、业务模块

(1)涉及到多个数据表 更新/添加 操作时,最外层要用事务,保证数据库操作的原子性;

(2)Model层,只做简单的数据表的查询,如字段scope查询封装到model层;

(3)业务逻辑,有重复利用性质的,要封装出来,减少重复性代码;

(4)控制器只做URL路由,不要当作 业务方法 调用;

二、代码样式风格

1、命名空间(Namespace) 和 导入(Use)声明

先简单文字描述下:

  1. 命名空间(namespace)的声明后面必须有一行空行;

  2. 所有的导入(use)声明必须放在命名空间(namespace)声明的下面;

  3. 一句声明中,必须只有一个导入(use)关键字;

  4. 在导入(use)声明代码块后面必须有一行空行;

用代码来说明下:

<?php

namespace Lib\Databases; // 下面必须空格一行

class Mysql {

}

namespace下空一行,才能使用use,再空一行,才能声明class

<?php

namespace Lib\Databases; // 下面必须空格一行

use FooInterface; // use 必须在namespace 后面声明

use BarClass as Bar;

use OtherVendor\OtherPackage\BazClass; // 下面必须空格一行

class Mysql {

}

2、类(class),属性(property)和方法(method)

(1)继承(extends) 和实现(implement) 必须和 class name 写在一行。

<?php

namespace Lib\Databaes;

class Mysql extends ParentClass implements \PDO, \DB { // 写一行

}

(2)属性(property)必须声明其可见性,到底是 public 还是 protected 还是 private,不能省略,也不能使用var, var是php老版本中的什么方式,等用于public。

<?php

namespace Lib\Databaes;

class Mysql extends ParentClass implements \PDO, \DB { // 写一行

    public $foo = null;

    private $name = 'yangyi';

    protected $age = '17';

}

(3)方法(method),必须 声明其可见性,到底是 public 还是 protected 还是 private,不能省略。如果有多个参数,第一个参数后紧接“,” ,再加一个空格:function_name (par,par2, $pa3), 如果参数有默认值,“=”左右各有一个空格分开。

<?php

namespace Lib\Databaes;

class Mysql extends ParentClass implements \PDO, \DB { 
    // 写一行
    public getInfo($name, $age, $gender = 1) {
        // 参数之间有一个空格。默认参数的“=”左右各有一个空格,) 与 { 之间有一个空格
    }
}

(4)当用到抽象(abstract)和终结(final)来做类声明时,它们必须放在可见性声明 (public 还是protected还是private)的前面。而当用到静态(static)来做类声明时,则必须放在可见性声明的后面。

直接上代码:

<?php

namespace Vendor\Package;

abstract class ClassName {

    protected static $foo; // static放后面

    abstract protected function zim(); // abstract放前面

    final public static function bar() { // final放前面,static放最后。
        // 方法主体部分
    }
}

3、控制结构

控制接口,就是 if else while switch等。这一类的写法规范也是经常容易出现问题的,也要规范一下。

(1)if,elseif,else写法,直接上规范代码吧:

<?php

if ($expr1) {
 // if 与 ( 之间有一个空格,) 与 { 之间有一个空格

} else if ($expr2) { 
// eles if 不连着写,与 ( 之间有一个空格,) 与 { 之间有一个空格

} else {
 // else 左右各一个空格

}

(2)switch,case 注意空格和换行,还是直接上规范代码:

<?php

switch ($expr) {
     // switch 与 ( 之间有一个空格,) 与 { 之间有一个空格
    case 0:
        echo 'First case, with a break'; // 对齐
        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;
}

(3)while,do while 的写法也是类似,上代码:

<?php

while ($expr) { 
    // while 与 ( 之间有一个空格, ) 与 { 之间有一个空格
}

do { 
    // do 与 { 之间有一个空格
} while ($expr); // while 左右各有一个空格

(4)for的写法

<?php

for ($i = 0; $i < 10; $i++) {
   // for 与 ( 之间有一个空格,二元操作符 "="、"<" 左右各有一个空格,) 与 { 之间有一个空格
}

(5)foreach的写法

<?php

foreach ($iterable as $key => $value) {
 // foreach 与 ( 之间有一个空格,"=>" 左右各有一个空格,) 与 { 之间有一个空格
}

(6)try catch的写法

<?php

try {
   // try 右边有一个空格
} catch (FirstExceptionType $e) {
   // catch 与 ( 之间有一个空格,) 与 { 之间有一个空格
} catch (OtherExceptionType $e) {
 // catch 与 ( 之间有一个空格,) 与 { 之间有一个空格
}

4、注释

(1)行注释

// 后面需要加一个空格;

如果 // 前面有非空字符,则 // 前面需要加一个空格;

(2)函数注释

参数名、属性名、标签的文本 上下要对齐;

在第一个标签前加一个空行;

<?php

/**

 * This is a sample function to illustrate additional PHP

 * formatter options.

 *

 * @param        $one   The first parameter

 * @param int    $two   The second parameter

 * @param string $three The third parameter with a longer

 *                      comment to illustrate wrapping.

 * @return void

 * @author  52[php.cnblogs.com](http://php.cnblogs.com/)

 * @license GPL

 */

function foo($one, $two = 0, $three = "String") {

}

5、空格

(1)赋值操作符(=,+= 等)、逻辑操作符(&&,||)、等号操作符(==,!=)、关系运算符(<,>,<=,>=)、按位操作符(&,|,^)、连接符(.) 左右各有一个空格;

(2)if,else,elseif,while,do,switch,for,foreach,try,catch,finally 等 与 紧挨的左括号“(”之间有一个空格;

(3)函数、方法的各个参数之间,逗号(",")后面有一个空格;

6、空行

(1)所有类函数左花括号 { 都换行,并且 { 紧挨着的下方,一定不是空行;

(2)所有非类函数,比如if,try while等函数左花括号 { 都不换行。

(2)同级代码(缩进相同)的 注释(行注释/块注释)前面,必须有一个空行;

(3)各个方法/函数 之间有一个空行;

(4)namespace语句、use语句、clase语句 之间有一个空行;

(5)return语句

如果 return 语句之前只有一行PHP代码,return 语句之前不需要空行;

如果 return 语句之前有至少二行PHP代码,return 语句之前加一个空行;

(6)if,while,switch,for,foreach、try 等代码块之间 以及 与其他代码之间有一个空行;

PSR-4 规范

PSR-4规范是刚出没多久的一条新的规范,它也是规范 自动加载(autoload)的,是对PSR-0的修改,属于补充规范,

我简单说下,主要是以下几点:

  1. 废除了PSR-0中就是目录分割符的写法,下划线在完全限定类名中是没有特殊含义了。

  2. 类文件名要以 .php 结尾。

  3. 类名必须要和对应的文件名要一模一样,大小写也要一模一样。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 223,726评论 6 521
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 95,697评论 3 402
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 170,734评论 0 366
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 60,508评论 1 300
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 69,522评论 6 399
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,051评论 1 314
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,429评论 3 427
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,403评论 0 278
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,930评论 1 323
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,977评论 3 343
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,122评论 1 354
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,763评论 5 350
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,454评论 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,931评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,047评论 1 275
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,613评论 3 380
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,150评论 2 363

推荐阅读更多精彩内容

  • FIG 制定的 PHP 规范,简称 PSR,是 PHP 开发的事实标准。FIG 是 Framework Inter...
    fingerQin阅读 5,617评论 0 11
  • PHP 代码文件 必须以<?php 开头,不能用<? 以免配置为short_open_tag = off 时造成出...
    Rohn阅读 467评论 0 4
  • Clean Code PHP github地址 目录 介绍 变量使用见字知意的变量名同一个实体要用相同的变量名使用...
    code_nerd阅读 465评论 0 3
  • 我们写代码的时候,一个好的编码规范,对我们来说能够起到很多意向不到的效果: 1、提高我们的编码效率。 2、提高代码...
    赵客缦胡缨v吴钩霜雪明阅读 803评论 2 11
  • 作者:Scholer's Blog原文地址:http://0x1.im/blog/php/tidy-your-ph...
    IT程序狮阅读 748评论 0 4