开发规范

CRMEB单商户开发规范

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

目录和文件

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

函数和类、属性命名

  • 类的命名采用驼峰法(首字母大写),例如UserUserType,默认不需要添加后缀,例如UserController应该直接命名为User
  • 函数的命名使用小写字母和下划线(小写字母开头)的方式,例如get_client_ip
  • 控制器内方法命名使用小写字母和下划线(小写字母开头)的方式,例如get_client_ip
  • 方法的命名使用驼峰法(首字母小写),例如getUserName
  • 属性的命名使用驼峰法(首字母小写),例如tableNameinstance
  • 特例:以双下划线__打头的函数或方法作为魔术方法,例如__call__autoload

函数和方法的区别:函数是单独存在的,也就是面向过程部分定义的;而方法是依赖于类存在的,也就是面向对象中定义的

常量和配置

  • 常量以大写字母和下划线命名,例如APP_PATH
  • 配置参数以小写字母和下划线命名,例如url_route_onurl_convert
  • 环境变量定义使用大写字母和下划线命名,例如APP_DEBUG

数据表和字段

  • 数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如think_user表和user_name字段,不建议使用驼峰和中文作为数据表及字段命名。

系统编码

UTF-8 LF

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