开发规范

开发框架:Thinkphp6.0最新版,文档地址https://www.kancloud.cn/manual/thinkphp6_0/1037479

请理解并尽量遵循以下命名规范,可以减少在开发过程中出现不必要的错误。

ThinkPHP6.0遵循PSR-2命名规范和PSR-4自动加载规范,并且注意如下规范:

命名规范

目录和文件

  • 目录使用小写+下划线;
  • 类库、函数文件统一以.php为后缀;
  • 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;
  • 类(包含接口和Trait)文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;
  • 类名(包括接口和Trait)和文件名保持一致,统一采用驼峰法命名(首字母大写);

函数和类、属性命名

  • 类的命名采用驼峰法(首字母大写),例如 UserUserType
  • 函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip
  • 方法的命名使用驼峰法(首字母小写),例如 getUserName
  • 属性的命名使用驼峰法(首字母小写),例如 tableNameinstance
  • 特例:以双下划线__打头的函数或方法作为魔术方法,例如 __call__autoload

变量、常量和配置

  • 常量以大写字母和下划线命名,例如 APP_PATH
  • 配置参数以小写字母和下划线命名,例如 url_route_onurl_convert
  • 环境变量定义使用大写字母和下划线命名,例如 APP_DEBUG
  • 变量命名使用驼峰法,常规变量首字母小写,如 $myName
  • 数组定义使用中括号,杜绝使用array。如:$arr = ['color' => 'red'];

代码规范

  • 格式化代码,保持代码整洁、易读。
  • 合理运用空行,空行可以用来隔开相对独立的代码块,有利于阅读和理解。但是不要使用超过一行的空行。
  • 拆分较长的类,较长的方法。单个类或者方法不易过长,可拆分为多个子类或方法。