基本命名规范
ThinkPHP遵循PSR-2命名规范以及PSR-4自动加载规范,并注意如下规范:
如果你没有遵循某些规范,可能会导致部分功能的异常。
类和文件命名
类(包括接口、Trait)文件名和类名保持一致,并且使用首字母大写的驼峰命名;
函数文件、配置文件、路由定义文件等文件名使用小写规范;
无论类还是普通文件都使用.php后缀;
目录名统一使用小写规范,并且使用单数规范;
模板文件使用小写规范;
配置和变量命名
配置参数名统一使用小写规范;
常量定义统一使用大写规范;
环境变量定义统一使用大写规范;
函数和类、属性命名
函数的命名使用小写字母和下划线(小写字母开头)的方式,例如get_client_ip;
方法的命名使用驼峰法(首字母小写),例如getUserName;
属性的命名使用驼峰法(首字母小写),例如tableName、instance;
特例:以双下划线打头的函数或方法作为魔术方法,例如call和__callStatic;
使用统一的IDE以及代码规范配置或者插件
项目团队应当尽量使用统一的IDE作为开发工具,并规范一致的代码规范配置项,如果使用的第三方代码规范及自动完成插件。如果团队成员较多而无法完全统一,最低限度,项目代码风格必须遵循PSR-1和PSR-2规范。
发表评论