讲师中心 微信公众号
AI工具推荐 视频效率加速

如何写出漂亮的PHP代码

梦墨同学_3226

梦墨同学_3226

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

|

2252人浏览过

|

来源于segmentfault

转载

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

如何写出漂亮的PHP代码

PHP文件开始标签

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

<?php

class TestDemo
{
}

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等流程控制结构,基本都需要与括号()和花括号{}配合使用,要求括号()两边均有一个空格,而左花括号{需要与右括号)同行且有一个空格,而作为结束的右花括号}则需要单独一行,而主体内容都是包含在花括号{}中。

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

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

快速一键格式化

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

最后总结

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

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

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

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

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

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

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

推荐学习:php视频教程

相关文章

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

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

下载

相关标签:

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

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

更多
phpstorm怎么导出项目
phpstorm怎么导出项目

phpstorm提供导出项目功能,步骤如下:打开phpstorm项目转到“项目”菜单选择“导出项目”选择导出格式指定导出位置选择导出范围勾选“包括依赖项”框(可选)单击“导出”完成导出。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1468

2024.04.08

phpStorm怎么运行
phpStorm怎么运行

本专题整合了phpstorm运行教程,阅读专题下面的文章了解更多相关内容。

6738

2025.09.18

phpstorm开发环境搭建教程
phpstorm开发环境搭建教程

本专题整合了phpstorm开发环境搭建和运行项目教程,阅读专题下面的文章了解更多详细教程。

6736

2025.09.18

phpstorm怎样运行php
phpstorm怎样运行php

本专题整合了phpstorm运行php相关教程,阅读专题下面的文章了解更多详细内容。

2301

2025.09.18

phpstorm相关教程大全
phpstorm相关教程大全

本专题整合了phpstorm相关教程汇总,阅读专题下面的文章了解更多详细内容。

158

2026.01.15

从环境搭建到代码调试:PHPstorm全流程开发配置指南
从环境搭建到代码调试:PHPstorm全流程开发配置指南

本文旨在为PHP开发者提供一份详尽的PhpStorm全流程开发配置指南。内容涵盖从IDE安装、PHP解释器配置、Xdebug调试环境搭建,到项目运行与断点调试的完整流程。通过本指南,读者将掌握搭建高效开发环境的核心技能,快速上手PhpStorm的强大功能,显著提升PHP开发效率。

141

2026.04.01

PHPstorm编辑器全系统安装与激活配置指南
PHPstorm编辑器全系统安装与激活配置指南

本文提供一份详尽的PHPstorm全系统安装与激活配置指南,覆盖Windows、macOS及Linux三大主流平台。内容从官方安装包的获取、安装过程中的路径与组件选择,到激活流程(包括正版激活与补丁替换法)均有详细图解。此外,指南还包含安装后的基础环境配置与中文语言包安装,旨在帮助开发者快速完成IDE部署,为PHP开发搭建一个稳定、高效的集成环境。

276

2026.04.01

ps软件新手入门教程合集
ps软件新手入门教程合集

PHP中文网精心打造了本PS新手入门教程合集。内容涵盖软件安装、界面认知、图层管理及抠图调色等核心技能,提供从零基础到精通的系统化学习路径。无论您是想快速上手修图还是进阶平面设计,都能在此找到实用指南与实战案例,助您轻松玩转Photoshop。

1080

2026.06.11

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn