2.3.2 常用的PHP规范编码
1)目录和文件
(1)目录不强制规范,驼峰和小写+下划线模式均支持;
(2)类库、函数文件统一以.PHP为后缀;
(3)类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;
(4)类名和类文件名保持一致,统一采用驼峰法命名(首字母大写),其他文件采用小写+下划线命名;
2)函数和类、属性命名
(1)类的命名采用驼峰法,且首字母大写,例如User、UserType,默认不需要添加后缀,例如UserController应该直接命名为User;
(2)函数的命名使用小写字母加下划线(小写字母开头)的方式,例如get_client_ip;
(3)方法的命名使用驼峰法,且首字母小写,例如getUserName;
(4)属性的命名使用驼峰法,且首字母小写,例如tableName、instance;
(5)以双下划线“____”打头的函数或方法作为魔法方法,例如____call和____autoload。(https://www.daowen.com)
3)常量和配置
(1)常量以大写字母加下划线命名,例如APP_PATH和ROOT_PATH;
(2)配置参数以小写字母加下划线命名,例如url_route_on和url_convert。
4)数据表和字段
数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如tb_user表和user_name字段,不建议使用驼峰和中文作为数据表字段命名。
5)数据表和字段
程序开发中难免需要对代码进行解释,或备注说明,或调试性提示,应当以注释的形式进行添加,添加注释,单行用//,多行用/∗∗/,需要调试或实验的代码可以添加debug字样,需要说明的可以加statement字样,方便在程序发布或调试时统一进行代码检查,如//debug。
6)应用类库命名空间规范
应用类库的根命名空间统一为app,也可以设置app_namespace配置参数更改,例如app\index\controller\Index和app\index\model\User。
【注意】
请避免使用PHP保留字作为常量、类名和方法名,以及命名空间的命名,否则会造成系统错误。