黑马程序员技术交流社区

标题: PHP小白应该知道的PHP开发中的命名约定 [打印本页]

作者: huawei    时间: 2016-10-14 11:53
标题: PHP小白应该知道的PHP开发中的命名约定
本帖最后由 huawei 于 2017-3-5 10:57 编辑

PHP小白应该知道的PHP开发中的命名约定


1. 类文件都是以“.class.php“为后缀,且类文件名只允许字母,使用驼峰法命名,并且首字母大写,例如:DbMysql.class.php 。

2. 配置和函数等其他类库文件之外的文件一般是分别以“.inc.php“和”.php“为后缀,且文件名命名使用小写字母和下划线的方式,多个单词之间以下 划线分隔,例如config.inc.php , common.php,install_function.php 。

3. 确保文件的命名和调用大小写一致,是由于在类Unix系统上面,对大小写是敏感的。

4. 类名和文件名一致(包括上面说的大小写一致),且类名只允许字母,例如 UserAction类的文件命名是UserAction.class.php, InfoModel类的文件名是InfoModel.class.php 。

5. 控制器类以Action为后缀,例如 UserAction、InfoAction ,模型类以Model为后缀,例如UserModel、InfoModel ,其他类也分别以相应分类为后缀,例如Service 、Widget。

6. 方法名只允许由字母组成,下划线是不允许的,首字母要小写,其后每个单词首字母要大写,即所谓的 “驼峰法命名” 规则,且越详细越好,应该能够描述清楚该方法的功能,例如switchModel、findPage。

7. 属性的命名只允许由字母组成,下划线是不允许的,首字母要小写,其后每个单词首字母要大写,即所谓的 “驼峰法命名” 规则,例如tablePrefix、tableName 。

8. 对于对象成员的访问,我们必须始终使用 “get” 和 “set” 方法。例如:




9. 当类成员方法被声明为 private 时,必须分别以双下划线 "__"为开头;被声明为 protected 时,必须分别以单下划线 "_" 为开头;一般情况下的方法不含下划线。例如 :



10. 如果我们需要把一些经常使用的方法定义为全局函数,那么应该把它们以静态 (static) 的形式定义在类中。例如:



11. 被声明为 private的类成员属性必须由双下划线 "__" 作为开头;被声明为 protected 的类成员属性必须由下划线 "_" 作为开头;而声明为 public 的成员属性则在任何时候都不允许含有下划线。

12. 函数的命名使用小写字母和下划线的方式,且越详细越好,应该能够描述清楚该函数的功能,例如 get_client_ip 。

13. 当方法或函数参数不一定需要被赋值的时候,用 "null" 来代替 "false" 作为函数参数的默认值,除非该参数是 boolean 值。

14. 变量只允许由小写字母和下划线组成,且建议用描述性的变量的命名,越详细越好,以至于像 $i 或 $n 等等都是不鼓励使用的。

15. 类中的常量 constant 和全局范围内常量define,只能由大写字母和下划线组成,各个单词之间以下划线分割。

16. boolean 值和 null 值都采用小写。


精华推荐:

视频集合:众多老学员呐喊:"为什么我选传智PHP"!


作者: eddies    时间: 2016-11-2 15:51
顶顶顶顶顶顶顶顶顶顶顶顶顶顶顶顶顶顶顶顶
作者: 小小海    时间: 2016-11-10 21:42
uwehrfiweudashnsah
作者: 15050187118    时间: 2016-11-11 11:24
测试.......
作者: 浅忆旧时光    时间: 2016-11-17 14:26
大苏打撒打算大打算打算
作者: jason_QS    时间: 2016-11-18 23:16
命名约定
作者: 夜歌行    时间: 2016-11-20 16:14
FADSSSSSSSSSSSSSSSSSSSSSSS
作者: piliyouxia121    时间: 2016-11-24 17:12

作者: ch123cn    时间: 2016-11-25 17:52
RE: PHP小白应该知道的PHP开发中的命名约定
作者: xxt598316205    时间: 2016-11-30 15:20
666666666666666666666666
作者: hp_eckj_luox    时间: 2016-12-12 16:43
PHP小白应该知道的PHP开发中的命名约定
作者: 肖肖肖    时间: 2016-12-18 23:53
谢谢分享!!!
作者: 290422624    时间: 2016-12-19 13:03
为什么必须回复才能看呢?
作者: VC丶万人敬仰    时间: 2017-1-3 17:09
66666666666666
作者: 1317181388    时间: 2017-2-3 01:11
感谢楼主分享
作者: heychm    时间: 2017-2-6 10:13
5666666666666666666666
作者: fjdaslfjk    时间: 2017-2-16 11:30
PHP开发中的命名约定
作者: devil_joker@qq.    时间: 2017-2-24 10:23
66666666666666666666
作者: 15814368371    时间: 2017-3-2 23:12
PHP小白必知的11个良好代码习惯
作者: vcflyfeel    时间: 2017-3-10 14:41
12345678905
作者: 风丨叶    时间: 2017-4-19 15:06
谢谢大神的分享
作者: 剑客星辰    时间: 2017-4-30 11:13
3333333333333333333333
作者: 咿呀咿呀哟    时间: 2017-5-2 11:14
感谢分享,谢谢~
作者: worldtongf    时间: 2017-5-20 23:20
PHP小白应该知道的编码风格
作者: 瞬间回忆    时间: 2017-5-24 16:23
PHP小白应该知道的PHP开发中的命名约定
作者: pykpyk    时间: 2017-8-9 21:48
666666666666666666666666666
作者: yuanlinjiayou    时间: 2017-9-8 21:35
11111111111111111
作者: hemou    时间: 2018-8-19 19:54
合理,统一的命名规则对于个人代码规整和团队协作都具有很大的益处
作者: 六点二十二    时间: 2018-9-18 22:39
学习~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
作者: hu838135705    时间: 2018-11-29 16:05
PHP小白应该知道的PHP开发中的命名约定
作者: Cgwxq    时间: 2022-12-29 17:23
来看看,看看怎么样,看看好不好




欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/) 黑马程序员IT技术论坛 X3.2