TP5的命名规范

TP5的命名规范

目录和文件

• 框架核心类库的目录统一使用小写规范，但应用目录名不强制规范，驼峰法和小写+下划线均支持，看团队规范；
• 类库、函数文件统一以.php为后缀；
• 类的文件名均以命名空间定义，并且命名空间的路径和类库文件所在路径一致（包括大小写）；
• 类名和类文件名保持一致，并统一采用驼峰法命名（首字母大写）

函数和类、属性命名

• 类的命名采用驼峰法，并且首字母大写，例如
  User、UserType，不需要添加controller、model等后缀，UserController直接更改为User；
• 函数的命名使用小写字母和下划线（小写字母开头）的方式，例如 get_client_ip；
• 方法的命名使用驼峰法，并且首字母小写或者使用下划线“_”，例如
  getUserName，_parseType，通常下划线开头的方法属于私有方法；
• 属性的命名使用驼峰法，并且首字母小写或者使用下划线“_”，例如 tableName、_instance，通常下划线开头的属性属于私有属性；
• 以双下划线“__”打头的函数或方法作为魔法方法，例如 __call 和 __autoload；

常量和配置

• 常量以大写字母和下划线命名，例如 APP_DEBUG和 APP_MODE；
• 配置参数以小写字母和下划线命名，例如 url_route_on；

数据表和字段

• 数据表和字段采用小写加下划线方式命名，并注意字段名不要以下划线开头，例如 think_user 表和 user_name字段，类似
  _username 这样的数据表字段可能会被过滤。

应用类库命名空间规范

• 应用类库的根命名空间统一为app（可以设置APP_NAMESPACE更改）；

例如：app\index\controller\Index和app\index\model\User。