习惯的PHP命名规则

Posted 2020-09-18

 从C++转PHP也已经很长一段时间了，一直有点代码洁癖，对于文件名，接口名，类名，方法名等都使用严格的驼峰命名法，

但是有时候会犹豫到底用首字母大写区分还是用下划线区分。今天简单总结和规约一下。

1.文件名

　　文件名统一使用大驼峰命名法，也就是把所有单词的首字母都大写，如：UserLoginController.php

2.类名

　　类名也使用大驼峰命名法，长度尽量控制在五个单词以内，如果逻辑描述过得，则采用缩写的形式，如：class Account, class RealNameVerify.

3.类方法名

　　类方法名使用小驼峰命名法，即首个单词全小写，其后单词全部首字母大写，并且首字母尽量描述操作类型，如：getUserInfo, updateGameConfig, bindPhone.

　　对于类的私有方法，应该以单个下划线开头的形式，如：_guestLogin

4.类成员变量和方法变量

　　虽然很多人主张类成员变量已m开头，但是个人习惯所有变量都使用小写字母机上下划线链接的形式定义，如：$game_repository, $table_config, $return_data.

　　顺带说一下比较好的变量命名方法吧：

　　1. 成员变量以 m 开头，如： $mTable, $mUrl

　　2. 静态变量以 s 开头， 如： $sCount, $sStatus

　　3. 全局变量以 g 开头， 如： $gConnectTime

5.类常量，全局常量

　　对于常量，使用所有字母大写，并用下划线连接单词的方式，如： PAYMENT_METHOD_TTBANK.

 

最后提一点，没有绝对最好的命名规范，只有最适合团队的命名规范，具体详细的命名规则还要根据使用的框架，具体的项目背景等来进行相应的变化。

但是一个统一的、清晰的、简单的命名规则，对于项目的开发和维护工作是很有用的。