vaeThink-命名规范


vaeThink和ThinkPHP5一样遵循PSR-2命名规范和PSR-4自动加载规范,并且注意如下规范:
目录和文件
  • 目录使用小写+下划线;
  • 类库、函数文件统一以.php为后缀;
  • 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;
  • 类文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;
  • 类名和类文件名保持一致,统一采用驼峰法命名(首字母大写);
函数和类、属性命名
  • 类的命名采用驼峰法(首字母大写),例如 User、UserType,但是vaeThink的控制器文件默认必须加上Controller后缀,但命名空间不需要带后缀,例如文件名为UserController的控制器文件其命名空间应该直接命名为User;
  • 函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip;
  • 方法的命名使用驼峰法(首字母小写),例如 getUserName;
  • 属性的命名使用驼峰法(首字母小写),例如 tableName、instance;
数据表和字段
  • 数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 vae_user 表和 user_name字段,不建议使用驼峰和中文作为数据表字段命名。
严格来说,在开发中我们必须遵守相应的命名规范,以避免不必要的BUG!