0

0

如何写出漂亮的PHP代码

醉折花枝作酒筹

醉折花枝作酒筹

发布时间:2021-07-06 15:33:45

|

2132人浏览过

|

来源于segmentfault

转载

一个好的编码习惯靠平时的习惯养成,团队里有好的编码规范,并且每个人都按照制定的编码规范来执行,那么我相信代码的质量以及可维护性会上升一个档次。而目前php要求都要遵守psr标准规范,我只列举一部分编码中常用的写法进行说明,更多的规范大家可以搜索psr标准。

如何写出漂亮的PHP代码

PHP文件开始标签

对于纯PHP的代码文件,必须以的结束标签,至于为啥,感兴趣的自己去了解哈。

Class类的声明

类名必须以大写开头的驼峰式命名(TestDemo),两个花括号换行且独占一行,同时需要用多行注释说明类的创建人以及作用等。

/**
 * 这是一个测试Demo类
 * Author: gxcuizy
 * Date: 2021-05-25 13:57:16
 * Class TestClass
 */
class TestDemo
{
}

Class类的常量

类中的常量命名必须全部字母都要大写(HELLO_WORLD),同时单词间以下划线_分隔,而且最好增加注释说明,单行注释最好在//后先加一个空格再接注释说明。

立即学习PHP免费学习笔记(深入)”;

// 声明一个常量
const HELLO_WORLD = 'best';

Class类的成员属性

类中的成员属性(也叫成员变量),成员属性的命名可以遵循三个规则:大写开头的驼峰式($UserName)、小写开头的驼峰式($userName)、下划线分隔式($user_name);这三种命名规则都可以,我个人习惯用下划线分隔式,大家也可以根据自己的习惯选择,但是最好与团队编码规则保持一致即可,同时三个修饰符(public、protected、private)不能少。

// 声明一个公共变量
public $user_name = '';
// 声明一个静态变量
public static $user_age = 18;

Class类的成员方法

类中的成员方法的命名必须采用小写开头的驼峰式命名(testAction)规则,方法的三个修饰符(public、protected、private)不能少,两个花括号换行且独占一行,参数的等号两边各一个空格,方法的注释不要漏了哈,包括方法的作用、参数说明以及返回值说明等。

/**
 * 这是一个测试方法
 * @param string $msg 参数说明
 * @return array
 */
public function testAction($msg = '')
{
    // 返回数据格式
    $return = array('code' => 200, 'msg' => '');
    return $return;
}

/**
 * 这是私有方法,方法命名以单下划线开始
 * @param string $arg 参数说明
 * @return string
 */
private function privateAction($arg = '')
{
    return $arg;
}

运算符和表达式

相对于运算符或者不同类型的表达式,不管在任何地方使用,我们都需要在其符号两边有一个空格,例如$a = 1;、1 + 2以及1 && 0等。

/**
 * 获取两个数相加的和
 * @param int $one 第一个数
 * @param int $two 第二个数
 * @return int
 */
public function getUserAge($one = 0, $two = 0)
{
    $sum = $one + $two;
    return $sum;
}

控制结构的规范写法

类似if …… else、while、switch ……case、foreach、for等流程控制结构,基本都需要与括号()和花括号{}配合使用,要求括号()两边均有一个空格,而左花括号{需要与右括号)同行且有一个空格,而作为结束的右花括号}则需要单独一行,而主体内容都是包含在花括号{}中。

/**
 * 判断用户是否成年
 * @param int $age 年龄
 */
public function logicAction($age = 18)
{
    if ($age >= 18) {
        echo '已成年';
    } else {
        echo '未成年';
    }
}

快速一键格式化

现在很多IDE都支持一键格式化代码,比如PhpStorm等,一般快捷键都是Ctrl + Alt + L,你也可以根据你自己的习惯进行修改快捷键以及代码格式的标准,既可以一键格式化整个文档,也可以只选中某一部分代码进行格式化。PS:如果这个文件不是你一个人创建和修改,请不要轻易一键格式化整个文件,因为会把人家的代码也给格式化了,推荐只格式化你自己的代码即可,每个人都不喜欢别人随意动自己的代码,所以不要搞事情!不要搞事情!不要搞事情!重要的事情说三遍,你懂的。

Asp.net企业网站管理系统2.0 (精美实用)
Asp.net企业网站管理系统2.0 (精美实用)

漂亮的企业网站。NET2.0出来了, 本次升级修改如下: 1、优化了3层结构。 2、优化了后台管理代码,增强了安全性能。 3、增加了系统名称及关键字管理。 4、增加了系统错误日志记录,自动生成Systemlog.log日志文件。 备注:本系统采用ASP.NET 2.O+ACCESS开发,请调试的朋友安装.NET2.0运行环境! 网站内容 网站栏目包括 首页|企业简介|新闻中心|产品展示|公司展示|

下载

最后总结

先给出个人的几点建议吧,希望对你有所帮助:

  • 别加多余的空格,也就是该加一个空格就加一个就行(按照代码规范来就行)

  • 多余的换行删除掉(影响代码视觉美观)

  • 调试代码记得及时删除,而不仅仅是注释(怕你久而久之就忘了)

  • 代码注释,代码注释,代码注释(再忙也要适当的写注释,不要说后面再加)

  • 你可以看不爽别人的代码,但是不要随意修改别人的代码(因为别人看你的代码也不爽)

我只是抽取了一小部分常用到的代码规范说一下,如果有写的不对的地方请大家指出,我会及时修改,谢谢。如果你还有其他好的编码技巧,也欢迎和大家一起分享。

推荐学习:php视频教程

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

1963

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1290

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1196

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

948

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1400

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1229

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1439

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1303

2023.11.13

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.1万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号