如何编写既优雅又耐看的PHP代码,遵循哪些书写规范?
- 内容介绍
- 文章标签
- 相关推荐
本文共计1443个文字,预计阅读时间需要6分钟。
如何编写优雅耐看的PHP代码?本文将带大家了解一些PHP代码的基本书写规范和框架规范,让你学会如何让你的PHP代码更上一层楼!
引言:今天老王同学跟我学习,他说他的代码好粗糙,像一堵墙。下面我们就来聊聊如何写出优雅耐看的PHP代码。
1. 基本书写规范
(1)代码缩进:使用4个空格进行缩进,避免使用Tab键。
(2)命名规范:遵循驼峰命名法,变量名、函数名等尽量简洁明了。
(3)注释:合理使用注释,对复杂逻辑、算法等进行注释,方便他人阅读。
(4)代码格式:保持代码整洁,避免冗余代码,如不必要的空格、换行等。
2. 框架规范
(1)MVC模式:采用MVC(模型-视图-控制器)模式,将业务逻辑、数据展示和用户交互分离。
(2)分层设计:将代码分层,如控制器层、模型层、视图层等,提高代码可维护性。
(3)依赖注入:使用依赖注入(DI)和依赖反转(IoC)原则,降低代码耦合度。
(4)代码复用:封装常用功能,提高代码复用性。
(5)单元测试:编写单元测试,确保代码质量。
通过以上规范,相信你的PHP代码会更加优雅耐看。让我们一起努力,写出更好的代码吧!
如何写出优雅耐看的PHP代码?本篇文章带大家了解一下PHP代码的基本书写规范和框架规范,了解它们让你的PHP代码优雅一个档次!引言
今天老王同学跟我说,他的代码好糟糕,像一坨xiang。问我要怎么
提高自己的代码质量,让自己代码看得顺眼一点,舒服一点, 就像
看到大长腿MM,两眼放光那种。
于是我: 你先这样,然后这样,然后再那样。。。。。。
老王同学: 别闹, 到底是哪样?
好的, 我要开始装13了。。。
基本规范
先说一下最基本的东西:
变量名使用驼峰命名。不懂的单词不要用拼音,而是要查词典找到对应的单词。
常量命名使用大写下划线方式命名。如:
SYSTEM_EROOR = 50000。缩进使用Tab键,不要打一堆空格做缩进。
类名首字母大写驼峰命名,需要见名知其意,注释说明这个类的功能。例如:
- 方法名驼峰命名,方法行数尽量控制在80行左右,注释说明函数干嘛用的。
- 花括号独占一行,例如:
- foreach慎用引用,例如以下代码会有问题:
预期结果是输出: 2 4 6,实际结果是2 4 4, 至于为什么可
以看我之前的文章: PHP中&符号你真的了解吗?。 可以使用array_walk`方法避免这个问题, 示例:
- 避免
if,elese嵌套过深,很多嵌套可以通过提前终止来消除, 举个简单的例子:
建议使用第二种方式,不符合条件的直接返回,剩下的就是符号条件的,那么避免了在if里面写很多代码。
多个
if/else使用switch来替代,PHP8.0版本可以使用match更为简洁。phpstorm中安装SonarLint插件。如果你写的代码出现虚线,说明不太理想,那么可以根据提示修改,相信有强迫症的同学一定会改,久而久之代码就很规范了。例如:
方法未使用,方法名不规范已经告诉你了,可以快捷修改,也可以自己修改。
框架规范
前面说得都是比较基础的东西,接下来才是主要的内容。
相信很多同学都用过常用的
thinkphp丶laravel丶yii等流行框架之一。这些框架都是MVC架构的,看过很多人的代码,要么把业务逻辑写在控制器里面,要么写在Model里面, 写在Model里面相比写控制器里面的还相对好一点。其实对于大型项目都不太友好。
下文以Laravel框架为例。
参数验证
API需要进行参数验证,但是参数验证写在哪里比较优雅呢?可能很多人在controller定义规则,然后在调用验证方法,那么验证那段代码将在每个API里面出现,例如我同事写的。
这段代码在每个API里面均会出现一次,岂不是很啰嗦,那么如何解决呢?
- 在Laravel的juejin.cn/post/6957290009682509854
作者:ClassmateLin
推荐学习:《PHP视频教程》
以上就是如何写出优雅耐看的PHP代码?浅谈书写规范的详细内容,更多请关注自由互联其它相关文章!
本文共计1443个文字,预计阅读时间需要6分钟。
如何编写优雅耐看的PHP代码?本文将带大家了解一些PHP代码的基本书写规范和框架规范,让你学会如何让你的PHP代码更上一层楼!
引言:今天老王同学跟我学习,他说他的代码好粗糙,像一堵墙。下面我们就来聊聊如何写出优雅耐看的PHP代码。
1. 基本书写规范
(1)代码缩进:使用4个空格进行缩进,避免使用Tab键。
(2)命名规范:遵循驼峰命名法,变量名、函数名等尽量简洁明了。
(3)注释:合理使用注释,对复杂逻辑、算法等进行注释,方便他人阅读。
(4)代码格式:保持代码整洁,避免冗余代码,如不必要的空格、换行等。
2. 框架规范
(1)MVC模式:采用MVC(模型-视图-控制器)模式,将业务逻辑、数据展示和用户交互分离。
(2)分层设计:将代码分层,如控制器层、模型层、视图层等,提高代码可维护性。
(3)依赖注入:使用依赖注入(DI)和依赖反转(IoC)原则,降低代码耦合度。
(4)代码复用:封装常用功能,提高代码复用性。
(5)单元测试:编写单元测试,确保代码质量。
通过以上规范,相信你的PHP代码会更加优雅耐看。让我们一起努力,写出更好的代码吧!
如何写出优雅耐看的PHP代码?本篇文章带大家了解一下PHP代码的基本书写规范和框架规范,了解它们让你的PHP代码优雅一个档次!引言
今天老王同学跟我说,他的代码好糟糕,像一坨xiang。问我要怎么
提高自己的代码质量,让自己代码看得顺眼一点,舒服一点, 就像
看到大长腿MM,两眼放光那种。
于是我: 你先这样,然后这样,然后再那样。。。。。。
老王同学: 别闹, 到底是哪样?
好的, 我要开始装13了。。。
基本规范
先说一下最基本的东西:
变量名使用驼峰命名。不懂的单词不要用拼音,而是要查词典找到对应的单词。
常量命名使用大写下划线方式命名。如:
SYSTEM_EROOR = 50000。缩进使用Tab键,不要打一堆空格做缩进。
类名首字母大写驼峰命名,需要见名知其意,注释说明这个类的功能。例如:
- 方法名驼峰命名,方法行数尽量控制在80行左右,注释说明函数干嘛用的。
- 花括号独占一行,例如:
- foreach慎用引用,例如以下代码会有问题:
预期结果是输出: 2 4 6,实际结果是2 4 4, 至于为什么可
以看我之前的文章: PHP中&符号你真的了解吗?。 可以使用array_walk`方法避免这个问题, 示例:
- 避免
if,elese嵌套过深,很多嵌套可以通过提前终止来消除, 举个简单的例子:
建议使用第二种方式,不符合条件的直接返回,剩下的就是符号条件的,那么避免了在if里面写很多代码。
多个
if/else使用switch来替代,PHP8.0版本可以使用match更为简洁。phpstorm中安装SonarLint插件。如果你写的代码出现虚线,说明不太理想,那么可以根据提示修改,相信有强迫症的同学一定会改,久而久之代码就很规范了。例如:
方法未使用,方法名不规范已经告诉你了,可以快捷修改,也可以自己修改。
框架规范
前面说得都是比较基础的东西,接下来才是主要的内容。
相信很多同学都用过常用的
thinkphp丶laravel丶yii等流行框架之一。这些框架都是MVC架构的,看过很多人的代码,要么把业务逻辑写在控制器里面,要么写在Model里面, 写在Model里面相比写控制器里面的还相对好一点。其实对于大型项目都不太友好。
下文以Laravel框架为例。
参数验证
API需要进行参数验证,但是参数验证写在哪里比较优雅呢?可能很多人在controller定义规则,然后在调用验证方法,那么验证那段代码将在每个API里面出现,例如我同事写的。
这段代码在每个API里面均会出现一次,岂不是很啰嗦,那么如何解决呢?
- 在Laravel的juejin.cn/post/6957290009682509854
作者:ClassmateLin
推荐学习:《PHP视频教程》
以上就是如何写出优雅耐看的PHP代码?浅谈书写规范的详细内容,更多请关注自由互联其它相关文章!

