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的“关键字”，必须小写：
'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；
（5）、类名必须要和对应的文件名要一模一样，大小写也要一模一样。
（6）、类文件名要以 .php 结尾
6、代码注释标签
如 函数注释、变量注释等，常用标签有 @package、@var、@param、@return、@author、@todo、@throws
必须遵守 phpDocument 标签规则，不要另外去创造新的标签，更多标签查看 phpDocument官网
7、业务模块
（1）、涉及到多个数据表 更新/添加 操作时，最外层要用事务，保证数据库操作的原子性；
（2）、Table层，只做数据表的查询；
（3）、业务逻辑统一封装到 Model层；
（4）、Module层按功能抽象可复用代码，避免重复造轮子；
（5）、Controller 控制器只做URL路由，不要当作 业务方法 调用；
（6）、控制器层不能出现SQL操作语句，如 ZendFramework框架的 from()、where()、order() 等方法，
即，控制器中，不要出现类似这样的SQL语句：$select->from('XXX')->where()->order()->limit();
where()、order()、limit() 等SQL方法只能出现在 table层！
二、代码样式风格
1、命名空间(Namespace) 和 导入(Use)声明
先简单文字描述下：
- 命名空间(namespace)的声明后面必须有一行空行；
- 所有的导入(use)声明必须放在命名空间(namespace)声明的下面；
- 一句声明中，必须只有一个导入(use)关键字；
- 在导入(use)声明代码块后面必须有一行空行；
如下：
1 <?php 2 namespace Lib\Databases; //下面必须空格一行 3 4 class Mysql{ 5 6 }
<?php namespace Lib\Databases; //下面必须空格一行 class Mysql{ }
namespace下空一行，才能使用use，再空一行，才能声明class
2、类(class)，属性(property)和方法(method)
（1）、继承(extends) 和实现(implement) 必须和 class name 写在一行。
（2）、属性(property)必须声明其可见性，到底是 public 还是 protected 还是 private，不能省略，也不能使用var, var是php老版本中的什么方式，等用于public。
（3）、方法(method)，必须 声明其可见性，到底是 public 还是 protected 还是 private，不能省略。
如果有多个参数，第一个参数后紧接逗号 “,” ，再加一个空格：function_name ($par, $par2, $pa3), 如果参数有默认值，“=”左右各有一个空格分开。
（4）、当用到抽象(abstract)和终结(final)来做类声明时，它们必须放在可见性声明 （public 还是protected还是private）的前面。而当用到静态(static)来做类声明时，则必须放在可见性声明的后面。
3、控制结构
控制结构，就是 if else while switch等。这一类的写法规范也是经常容易出现问题的，也要规范一下。
（1）、if，elseif，else写法，如下：
（2）、switch，case 注意空格和换行，如下：
（3）、while，do while 的写法也是类似，如下：
（4）、for的写法， 如下：
（5）、foreach的写法，如下：
（6）、try catch的写法，如下：
4、注释
（1）、行注释
// 后面需要加一个空格；
如果 // 前面有非空字符，则 // 前面需要加一个空格；
（2）、函数注释
参数名、属性名、标签的文本 上下要对齐；
在第一个标签前加一个空行；
5、空格
（1）、赋值操作符（=，+= 等）、逻辑操作符（&&，||）、等号操作符（==，!=）、关系运算符（<，>，<=，>=）、按位操作符（&，|，^）、连接符（.） 左右各有一个空格；
（2）、if，else，elseif，while，do，switch，for，foreach，try，catch，finally 等 与 紧挨的左括号“(”之间有一个空格；
（3）、函数、方法的各个参数之间，逗号（","）后面有一个空格；
6、空行
（1）、所有左花括号 ｛ 紧挨着的下方，不能是空行；
（2）、同级代码（缩进相同）的 注释（行注释/块注释）前面，必须有一个空行；
（3）、各个方法/函数 之间有一个空行；
（4）、namespace语句、use语句、clase语句 之间有一个空行；
（5）、如果 return 语句之前只有一行PHP代码，return 语句之前不需要空行；
（6）、如果 return 语句之前有至少二行PHP代码，return 语句之前加一个空行；
（7）、if，while，switch，for，foreach、try 等代码块之间 以及 与其他代码之间有一个空行；
【参考示例 汇总】
参考1：
参考2:
参考3：
参考4：
总结：所有左花括号 { 紧挨着的下方，一定不是空行！
version 2017.10.18
【补充】
（1）、数组的书写格式
只有一个键值对时，就写成一行：
有多个（二个或二个以上）键值对时，就换行：
