(1)、纯PHP代码源文件只使用 <?php 标签,省略关闭标签 ?>
(2)、源文件中PHP代码的编码格式必须是无BOM的UTF-8格式
(3)、一个源文件只做一种类型的声明,即,这个文件专门用来声明Class, 那个文件专门用来设置配置信息,别混在一起写
(1)、使用Tab键来缩进,每个Tab键长度设置为4个空格;
'__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'
(1)、类名 使用大驼峰式(StudlyCaps)写法;
(2)、(类的)方法名 使用小驼峰(cameCase)写法;
(3)、函数名使用 小写字母 下划线 写法,如 function http_send_post();
(4)、变量名 使用小驼峰写法,如 $userName;
如 函数注释、变量注释等,常用标签有 @package、@var、@param、@return、@author、@todo、@throws
必须遵守 phpDocument 标签规则,不要另外去创造新的标签
更多标签查看 phpDocument官网
(1)、涉及到多个数据表 更新/添加 操作时,最外层要用事务,保证数据库操作的原子性;
(2)、Model层,只做简单的数据表的查询;
(3)、控制器只做URL路由,不要当作 业务方法 调用;
(4)、控制器层不能出现SQL操作语句,如 ThinkPHP框架的 where()、order() 等模型方法,
即,控制器中,不要出现类似这样的SQL语句:D('XXX')->where()->order()->limit()->find();
where()、order()、limit() 等SQL方法只能出现在 Model层、业务层!
先简单文字描述下:
- 命名空间(namespace)的声明后面必须有一行空行;
- 所有的导入(use)声明必须放在命名空间(namespace)声明的下面;
- 一句声明中,必须只有一个导入(use)关键字;
- 在导入(use)声明代码块后面必须有一行空行;
代码如下:
<?php
namespace Lib\Databases; // 下面必须空格一行
class Mysql {
...
}
<?php
namespace Lib\Databases; // 下面必须空格一行
use FooInterface; // use 必须在namespace 后面声明
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass; // 下面必须空格一行
class Mysql {
...
}
<?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放最后。
// 方法主体部分
}
}
<?php
if ($expr1) { // if 与 ( 之间有一个空格,) 与 { 之间有一个空格
...
} elseif ($expr2) { // elesif 连着写,与 ( 之间有一个空格,) 与 { 之间有一个空格
...
} else { // else 左右各一个空格
...
}
<?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;
}
<?php
while ($expr) { // while 与 ( 之间有一个空格, ) 与 { 之间有一个空格
...
}
do { // do 与 { 之间有一个空格
...
} while ($expr); // while 左右各有一个空格
<?php
for ($i = 0; $i < 10; $i ) { // for 与 ( 之间有一个空格,二元操作符 "="、"<" 左右各有一个空格,) 与 { 之间有一个空格
...
}
<?php
foreach ($iterable as $key => $value) { // foreach 与 ( 之间有一个空格,"=>" 左右各有一个空格,) 与 { 之间有一个空格
...
}
<?php
try { // try 右边有一个空格
...
} catch (FirstExceptionType $e) { // catch 与 ( 之间有一个空格,) 与 { 之间有一个空格
...
} catch (OtherExceptionType $e) { // catch 与 ( 之间有一个空格,) 与 { 之间有一个空格
...
}
- (1)、类注释
/*
* File Name:README.md
* Auth:Qs
* Name:Demo
* Note:This a Demo for Class
* Time:2017/10/17 16:06
*/
- (2)、行注释
// 后面需要加一个空格;
如果 // 前面有非空字符,则 // 前面需要加一个空格; - (3)、函数注释
参数名、属性名、标签的文本 上下要对齐;
在第一个标签前加一个空行;
/*
* Auth:Qs
* Name:
* Note:
* @param array $one 第一个参数
* @param integer $two 第二个参数
* @param string $three 每三个参数,默认:string
* @param boolean $four 每四个参数:true/false
* @return void
* Time:2017/10/17 15:43
*/
function foo($one, $two = 0, $three = "String") {
...
}
- 赋值操作符(=, = 等)、逻辑操作符(&&,||)、等号操作符(==,!=)、关系运算符(<,>,<=,>=)、按位操作符(&,|,^)、连接符(.) 左右各有一个空格;
- if,else,elseif,while,do,switch,for,foreach,try,catch,finally 等 与 紧挨的左括号“(”之间有一个空格;
- 函数、方法的各个参数之间,逗号(",")后面有一个空格;
- 所有左花括号 { 都不换行,并且 { 紧挨着的下方,一定不是空行;
- 同级代码(缩进相同)的 注释(行注释/块注释)前面,必须有一个空行;
- 各个方法/函数 之间有一个空行;
- namespace语句、use语句、clase语句 之间有一个空行;
- return语句
如果 return 语句之前只有一行PHP代码,return 语句之前不需要空行; 如果 return 语句之前有至少二行PHP代码,return 语句之前加一个空行; - if,while,switch,for,foreach、try 等代码块之间 以及 与其他代码之间有一个空行;