返回顶部
首页 > 资讯 > 后端开发 > PHP编程 >如何规范地写PHP代码
  • 352
分享到

如何规范地写PHP代码

2023-06-20 14:06:43 352人浏览 安东尼
摘要

本篇内容主要讲解“如何规范地写PHP代码”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“如何规范地写php代码”吧!一个好的编码习惯靠平时的习惯养成,团队里有好的编码规范,并且每个人都按照制定的编

本篇内容主要讲解“如何规范地写PHP代码”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“如何规范地写php代码”吧!

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

PHP文件开始标签

对于纯PHP的代码文件,必须以<?php 或者<?标签开始,并且独占一行,同时不要加?>的结束标签,至于为啥,感兴趣的自己去了解哈。

<?phpclass TestDemo{}

Class类的声明

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

class TestDemo{}

Class类的常量

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

// 声明一个常量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)不能少,两个花括号换行且独占一行,参数的等号两边各一个空格,方法的注释不要漏了哈,包括方法的作用、参数说明以及返回值说明等。

public function testAction($msg = ''){    // 返回数据格式    $return = array('code' => 200, 'msg' => '');    return $return;}private function privateAction($arg = ''){    return $arg;}

运算符和表达式

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

public function getUserAge($one = 0, $two = 0){    $sum = $one + $two;    return $sum;}

控制结构的规范写法

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

public function logicAction($age = 18){    if ($age >= 18) {        echo '已成年';    } else {        echo '未成年';    }}

快速一键格式化

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

最后总结

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

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

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

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

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

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

到此,相信大家对“如何规范地写PHP代码”有了更深的了解,不妨来实际操作一番吧!这里是编程网网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

--结束END--

本文标题: 如何规范地写PHP代码

本文链接: https://lsjlt.com/news/297292.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • 如何规范地写PHP代码
    本篇内容主要讲解“如何规范地写PHP代码”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“如何规范地写PHP代码”吧!一个好的编码习惯靠平时的习惯养成,团队里有好的编码规范,并且每个人都按照制定的编...
    99+
    2023-06-20
  • 在java中如何编写规范的代码
    本篇内容介绍了“在java中如何编写规范的代码”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!一、MyBatis 不要为了多个查询条件而写 1...
    99+
    2023-06-16
  • PHP中的代码规范
    PHP是一种广泛应用于web开发的编程语言。定义一个好的代码规范能够提高代码的可读性,减少出错的概率,使代码更加易于维护。在PHP中,代码规范要尤为重要。本文将介绍PHP中常见的代码规范。缩进风格缩进是一种很重要的程序语言排版方式。对于PH...
    99+
    2023-05-24
    代码规范 PHP规范 编程规范
  • PHP中如何进行代码规范约束?
    随着web应用程序的不断发展,PHP已成为最广泛使用的服务器端脚本语言之一。在PHP开发过程中,为了实现高效、可维护和可扩展的代码,代码规范是必不可少的。本篇文章将介绍PHP中如何进行代码规范约束,以确保代码风格一致且易于理解,从而提高团队...
    99+
    2023-05-14
    PHP 代码规范 约束
  • 如何在PHP开发中优化代码编写和命名规范?
    如何在PHP开发中优化代码编写和命名规范?在 PHP 开发中,优化代码编写和命名规范是非常重要的,它们可以提高代码的可读性、可维护性和可扩展性。本文将介绍一些在 PHP 开发中优化代码编写和命名规范的方法。一、代码编写的优化使用合理的缩进和...
    99+
    2023-11-04
    代码 优化 命名规范
  • CSS代码书写规范有哪些
    本篇文章为大家展示了CSS代码书写规范有哪些,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。1.格式化代码1.1文件[建议]:CSS文件使用无BOM的UTF-8编码1...
    99+
    2024-04-02
  • C# 代码大小写规范说明
    目录C# 代码大小写规范下表描述了不同类型标识符的大小写规则C#中的大小写约定大小写样式标识符的大小写规则首字母缩写的大小写规则复合词和常用术语的大小写规则区分大小写C# 代码大小写...
    99+
    2024-04-02
  • Python代码规范和命名规范
    前言 Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯 目录 一、简明概述 1、编码 如无特殊情况, 文件一律使用 UTF-8 编码如无特殊情况, 文件头部必...
    99+
    2023-01-31
    代码 Python
  • Python 代码规范
    Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯。 1、编码 如无特殊情况, 文件一律使用 UTF-8 编码 如无特殊情况, 文件头部必须加入#-*-coding:utf...
    99+
    2023-01-31
    代码 Python
  • PHP开发的代码书写以及文件命名规范
    这篇文章主要介绍“PHP开发的代码书写以及文件命名规范”,在日常操作中,相信很多人在PHP开发的代码书写以及文件命名规范问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”PHP开发的代码书写以及文件命名规范”的疑...
    99+
    2023-06-17
  • CSS代码高效编写规范有哪些
    这篇文章将为大家详细讲解有关CSS代码高效编写规范有哪些,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。一些高效的CSS代码编写规范CSS学起来并不难,但在大...
    99+
    2024-04-02
  • Java代码书写规范的示例分析
    这篇文章主要介绍了Java代码书写规范的示例分析,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。一、目的   对于代码,首要要求是它必须正确,能够按照程序员的真实思想...
    99+
    2023-06-03
  • 如何编写规范的 PHP 函数文档?
    为 php 函数编写文档应遵循标准化惯例,包括命名规范、使用 @param、@return 和 @throws 标签指定参数类型、返回值类型和异常类型,并采用 psr-5 注释块标准。以...
    99+
    2024-04-27
    php 函数文档规范
  • 如何使用eslint和editorconfig规范代码
    这篇文章主要为大家展示了“如何使用eslint和editorconfig规范代码”,内容简而易懂,条理清晰,希望能够帮助大家解决疑惑,下面让小编带领大家一起研究并学习一下“如何使用eslint和editor...
    99+
    2024-04-02
  • 基于PHP的PSR2和PSR4规范的代码规范检查工具
    引言:在软件开发过程中,良好的代码规范是保证程序质量和可维护性的重要因素。为了帮助开发人员遵循PHP代码规范,PHP-FIG(PHP Framework Interop Group)提出了PSR(PHP Standards Recommen...
    99+
    2023-10-21
    PHP PSR
  • Vue代码规范有哪些
    这篇文章将为大家详细讲解有关Vue代码规范有哪些,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。一、JS部分1. 和渲染无关的数据vue中data的数据默认便...
    99+
    2024-04-02
  • JavaScript代码规范有哪些
    本篇内容介绍了“JavaScript代码规范有哪些”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!所有的 J...
    99+
    2024-04-02
  • C#代码规范有哪些
    C#代码规范有哪些,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。1. 引言按照此规范来开发C#程序可带来以下益处:&middot; 代码的编写...
    99+
    2023-06-17
  • Flex代码规范有哪些
    这篇文章给大家介绍Flex代码规范有哪些,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。Flex代码规范1.前言1.1目的对于代码,首要要求是它必须正确,能够按照程序员的真实思想去运行;第二个的要求是代码必须清晰易懂,使...
    99+
    2023-06-17
  • Java代码规范有哪些
    这篇文章给大家介绍Java代码规范有哪些,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。1.命名规范(1)所有的标示符都只能用ASCⅡ字母(A-Z或a-z)、数字(0-9)和下划线“_”。(2)一个***包名的前缀总是全...
    99+
    2023-06-17
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作