团队开发常用命名规则

发布于2017-03-31  620次阅读


工作中禁止出现:res,result,bool。
目录和文件
  • 目录使用小写+下划线;
  • 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;
  • 类文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;
  • 类名和类文件名保持一致,统一采用驼峰法命名(首字母大写);
函数和类、属性命名
  • 类的命名采用驼峰法(首字母大写),例如 User、UserType,默认不需要添加后缀,
  • 函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip;
  • 方法的命名使用驼峰法(首字母小写),例如 getUserName;
  • 属性的命名使用驼峰法(首字母小写),例如 tableName、instance;
  • 以双下划线“__”打头的函数或方法作为魔法方法,例如 __call 和 __autoload;
常量和配置
  • 常量以大写字母和下划线命名,例如 APP_PATH和 THINK_PATH;
  • 配置参数以小写字母和下划线命名,例如 url_route_on 和url_convert;
数据表和字段
  • 数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user 表和 user_name字段,不建议使用驼峰和中文作为数据表字段命名。

  • 微信或支付宝

道,可道,非常道;名,可名,非常名。