当前位置: 首页 > 后端技术 > PHP

PHP规范与工具

时间:2023-03-30 00:42:56 PHP

>作为新手,编写规范的代码也是必修课。除了阅读相应的代码规范文档,充分利用相关工具,可以让进阶之路事半功倍。今天的分享将简单回顾一下PHP规范,并介绍一款代码检查工具CodeSniffer,结合PHPStorm和GIT进行实践。为什么PHP规范需要一个统一的代码规范?PHP社区正在蓬勃发展,拥有大量的库、框架和组件。PHP开发人员通常在他们的项目中使用多个外部库,因此PHP代码遵循(尽可能接近)相同的代码风格非常重要,这可以让开发人员轻松地将多个代码库集成到他们的项目中。目前流行的一些规范:PSRPSR是PHPStandardRecommendations的缩写。PHPFIG组织制定的PHP规范是PHP开发的实践标准。PHPFIG,FIG是FrameworkInteroperabilityGroup(框架互操作性组织)的缩写,该组织于2009年由几位开源框架开发者成立,此后也挑选了许多其他成员(包括但不限于Laravel、Joomla、Drupal、Composer、Phalcon、Slim、Symfony、ZendFramework等)虽然不是“官方”组织,但代表了大部分PHP社区。该项目的目的是通过框架作者或框架代表之间的讨论制定一个限制最少的协作标准,每个框架都遵循统一的编码标准,以避免PHP的发展受到各自的自开发风格的阻碍。框架,并解决这个问题。程序员已经被困扰了很久。目前已经投票通过了6套标准,得到了大部分PHP框架的支持和认可。详细介绍请参考官方说明:中文文档官网PEARPEARCodingStandards适用于PEAR官方发行版中的代码。编码标准在开发人员中通常缩写为CS,它们旨在使代码保持一致,以便大多数PEAR人员易于阅读和维护。参考ZendZendFramework使用的官方代码规范。官方说明参考CodeSniffer官网:https://github.com/squizlabs/PHP_CodeSnifferPHP_CodeSniffer是一套两个PHP脚本;主要的phpcs脚本对PHP、JavaScript和CSS文件进行标记以检测是否违反定义的编码标准,第二个phpcbf脚本可自动更正编码标准的违规行为。PHP_CodeSniffer是一个必不可少的开发工具,可确保您的代码保持干净和一致。简而言之就是两个小工具,phpcs(PHPCodeStandard),用于检查代码规范phpcbf(PHPCodeBeautifierandFixer),用于自动修复代码InstallCodeSniffer参考官方文档使用CodeSniffer执行phpcs检查代码规范$phpcs/path/to/code/myfile.phpFILE:/path/to/code/myfile.php------------------------------------------------------------------------------发现5个错误影响4行------------------------------------------------------------------------------2|错误|[]缺少文件文档注释3|错误|[x]TRUE、FALSE和NULL必须小写;预期“假”但是||发现“假”5|错误|[x]行缩进错误;预计至少4个空格,找到18|错误|[]缺少函数文档注释8|错误|[]大括号应换行------------------------------------------------------------------------------PHPBF可以自动修复2个标记的嗅探违规------------------------------------------------------------------------------Code-Sniffer默认使用PEAR代码规范,可以通过--standard=xxx指定。$phpcs--standard=PSR2/path/to/code/myfile.php或者修改默认配置$phpcs--config-setdefault_standardSquiz执行phpcbs修复代码$phpcbf/path/to/codeProcessinginit.php[PHP=>960行中的7875个标记]...在274毫秒内完成(12次可修复的违规)=>修复文件:剩余0/12次违规[通过3次]...在412毫秒中完成处理config.php[PHP=>957行中的8009个标记]...在421毫秒内完成(155次可修复的违规)=>修复文件:剩余0/155次违规[通过7次]...在937毫秒内完成修补2个文件时间:2.55秒,内存:25.00Mb有关更多功能,请参阅官方文档与PHPStorm集成CodeSniffer与PHPStorm集成,可以让IDE实时显示代码规范,提醒开发者修改代码,长期使用,开发者可以养成非常规范的代码习惯。如何配置?为PHPStorm配置代码嗅探器路径:![code-sniffer](http://imgur.com/X4rIc0e.png)![code-sniffer](http://imgur.com/TdqQVfz.png)适当的编码标准![](http://imgur.com/hLmHbZo.png)使用GITHook强制执行代码检查使用GIT的Pre-CommitHook,您可以在提交代码之前强制调用CodeSniffer进行代码检查。规范,将阻止用户提交代码。在项目的.git/hooks中创建一个pre-commit文件并编写代码:[Pre-CommitGist](https://gist.githubusercontent.com/yangzhyo/6dad52e862c5efa368c992efc52e1fb9/raw/dec18f55ddfdf6eeb6d659a19398ec2d106fface/pre-commit.php)试试出来:)

最新推荐
猜你喜欢