首页 > 代码库 > PHP团队 编码规范 & 代码风格规范
PHP团队 编码规范 & 代码风格规范
一、基本约定
1、源文件
(1)、纯PHP代码源文件只使用 <?php 标签,省略关闭标签 ?> ;
(2)、源文件中PHP代码的编码格式必须是无BOM的UTF-8格式;
(3)、使用 Unix LF(换行符)作为行结束符;
(4)、一个源文件只做一种类型的声明,即,这个文件专门用来声明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;
二、代码风格
1、命名空间(Namespace) 和 导入(Use)声明
先简单文字描述下:
- 命名空间(namespace)的声明后面必须有一行空行;
- 所有的导入(use)声明必须放在命名空间(namespace)声明的下面;
- 一句声明中,必须只有一个导入(use)关键字;
- 在导入(use)声明代码块后面必须有一行空行;
用代码来说明下:
<?phpnamespace Lib\Databases; // 下面必须空格一行 class Mysql{}
namespace下空一行,才能使用use,再空一行,才能声明class
<?phpnamespace 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 写在一行,且花括号要换行写。
<?phpnamespace Lib\Databaes;class Mysql extends ParentClass implements \PDO, \DB // 写一行{ // 换行写 { }
(2)、属性(property)必须声明其可见性,到底是 public 还是 protected 还是 private,不能省略,也不能使用var, var是php老版本中的什么方式,等用于public。
<?phpnamespace 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), 如果参数有默认值,“=”左右各有一个空格分开。
<?phpnamespace Lib\Databaes;class Mysql extends ParentClass implements \PDO, \DB // 写一行{ public getInfo($name, $age, $gender = 1) // 参数之间有一个空格。默认参数的“=”左右各有一个空格 { // 必须换行写 { }}
(4)、当用到抽象(abstract)和终结(final)来做类声明时,它们必须放在可见性声明 (public 还是protected还是private)的前面。而当用到静态(static)来做类声明时,则必须放在可见性声明的后面。
直接上代码:
<?phpnamespace 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写法,直接上规范代码吧:
<?phpif ($expr1) // if 与 ( 之间有一个空格{ // 必须换行写 {}elseif ($expr2) // elesif 连着写,与 ( 之间有一个空格{ // 必须换行写 {}else{ // 必须换行写 {}
(2)、switch,case 注意空格和换行,还是直接上规范代码:
<?phpswitch ($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 的写法也是类似,上代码:
<?phpwhile ($expr) // while 与 ( 之间有一个空格{ // 换行写 {}do{ // 换行写 {} while ($expr); // while 左右各有一个空格
(4)、for的写法
<?phpfor ($i = 0; $i < 10; $i++) // for 与 ( 之间有一个空格,二元操作符 "="、"<" 左右各有一个空格{ // 换行写 {}
(5)、foreach的写法
<?phpforeach ($iterable as $key => $value)// foreach 与 ( 之间有一个空格,"=>" 左右各有一个空格{ // 换行写 { }
(6)、try catch的写法
<?phptry{ // 换行写 {}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 52php.cnblogs.com * @license GPL */function foo($one, $two = 0, $three = "String"){}
参考:
代码风格研究:左花括号 是否换行???
PHP中PSR-[0-4]代码规范
PHP团队 编码规范 & 代码风格规范