命名规范

优秀的代码本身就是可读性极强的文档,可读性要求代码本身要遵守一定的命名规则。 命名规则最重要的是规则的一致性。 命名规范基于thinkphp6命名规范做了文字细节调整。

命名规范

请理解并尽量遵循命名规范,可以减少在开发过程中出现不必要的错误。 文件命名规则、类型命名规则、变量命名规则、还有常量、函数和命名空间等细节参看对应章节。 参考命名规范见下文。

目录和文件

(1) 目录使用小写+下划线; (2) 类库、函数文件统一使用小写简化后缀,比如.php.c.h.cpp.js.html.py,不要出现.hpp.HTML等不符合简化和小写的命名; (3) 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致; (4) 类(包含接口和Trait)文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名; (5)类名(包括接口和Trait)和文件名保持一致,统一采用驼峰法命名(首字母大写);

函数和类、属性命名

(1) 类的命名采用驼峰法(首字母大写),例如 UserUserType; (2) 函数和方法的命名使用小驼峰法(首字母小写)的方式,例如 getClientIp; (3)变量的命名使用驼峰法(首字母小写),例如 tableNameinstance; (4)特例:以双下划线__打头的函数或方法作为魔术方法,例如 __call__autoload

常量和配置

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

数据表和字段

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

请避免使用编程语言保留字作为常量、变量名、类名和方法名,以及命名空间的命名,否则会造成系统错误。。比如 switch、if 等等。 (如php保留字列表参见 http://php.net/manual/zh/reserved.keywords.php