文档:开发规范

文档:开发规范

命名规范

类名和类文件名保持一致,统一采用驼峰法命名(首字母大写);

函数和类、属性命名

  1. 类的命名采用驼峰法(首字母大写),例如 User、UserType,默认不需要添加后缀,例如UserController应该直接命名为User;

  2. 函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip;

  3. 方法的命名使用驼峰法(首字母小写),例如 getUserName;

  4. 属性的命名使用驼峰法(首字母小写),例如 tableName、instance;

  5. 特例:以双下划线打头的函数或方法作为魔术方法,例如 call 和 __autoload

常量和配置

  1. 常量以大写字母和下划线命名,例如 APP_DIR;

  2. 配置参数以小写字母和下划线命名,例如 app 和 app_module;

  3. 环境变量定义使用大写字母和下划线命名,例如 DEBUG;

数据表和字段

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