前言:
为方便自己或者后人阅读之前写的代码,写php的要求遵循以下代码规范,大家看一看,不强求全部做到,尽量做到即可。
参考自ThinkPHP项目及代码规范指北、PSR-1 基础编码规范、PSR-2 编码风格规范。
编写规范
代码 必须 使用 4 个空格来进行缩进。
类的开始花括号({)写在函数声明后自成一行,结束花括号(})也写在函数主体后自成一行。
`create database hero;`
class Lottery extends Controller
{
}
```
方法的开始花括号({)写在函数声明后自成一行,结束花括号(})也写在函数主体后自成一行。
控制结构的开始花括号({)写在声明的同一行,而结束花括号(})写在主体后自成一行。
基本命名规范:
类和文件命名
类(包括接口、Trait)文件名和类名保持一致,并且使用首字母大写的驼峰命名;
函数文件、配置文件、路由定义文件等文件名使用小写规范;
无论类还是普通文件都使用.php后缀;
目录名统一使用小写规范,并且使用单数规范;
模板文件使用小写规范;
配置和变量命名
配置参数名统一使用小写规范;
常量定义统一使用大写规范;
环境变量定义统一使用大写规范;
函数和类、属性命名
函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip;
方法的命名使用驼峰法(首字母小写),例如 getUserName;
属性的命名使用驼峰法(首字母小写),例如 tableName、instance;
特例:以双下划线__打头的函数或方法作为魔术方法,例如__call 和 __callStatic;