PHPstorm配置PHP_CodeSniffer代码检查工具

• 1.PHP CodeSniffer介绍
• 2.安装PHP_CodeSniffer
• 3.使用 PHPStorm 设置 PHPCS
• 4.测试PHP_CodeSniffer的检测功能
• 参考资料

1.PHP CodeSniffer介绍

PHP_CodeSniffer 对 PHP 文件进行标记，并检测违反一组定义的编码标准的情况。
PHP_CodeSniffer 是一组两个 PHP 脚本：主脚本 phpcs 对 PHP、JavaScript 和 CSS 文件进行标记，以检测是否违反定义的编码标准；第二个脚本 phpcbf 自动纠正违反编码标准的行为。PHP_CodeSniffer 是一个重要的开发工具，可以确保你的代码保持干净和一致。

一些常用的 PHP 代码检查工具包括 PHP CodeSniffer、PHP Mess Detector 和 PHPLint。这些工具都可以帮助您检查代码质量，并确保代码遵循规范和最佳实践。这里介绍日常开发过程中，利用phpstorm软件配置PHP CodeSniffer来实现自动检测代码开发质量问题

2.安装PHP_CodeSniffer

下载PHP_CodeSniffer：https://pear.php.net/package/PHP_CodeSniffer/download 将下载下来的压缩包放到自定义指定目录，并进行解压

3.使用 PHPStorm 设置 PHPCS

PHPStorm 原生支持使用 PHP_CodeSniffer 进行代码检查，可以按下面步骤完成配置。

首先，启动“Settings”对话框 (Ctrl+Alt+S) 并导航到Languages & Frameworks > PHP > Quality Tools。展开 Quality Tools 页面上的 PHP Code Sniffer，然后从 Configuration 下拉列表中选择 Local。单击下面突出显示的下拉列表旁边的“...”按钮，之后将 phpcs.bat 绝对路径维护进去，点击“Validate”按钮进行校验确认phpcs是否生效，生效则点"Apply"->"OK"，如下图所示。

然后你可能看到如下图所示，提示“PHP_CodeSniffer inspection is not enabled”，如下图：

请按下图解决“PHP_CodeSniffer inspection is not enabled”问题

4.测试PHP_CodeSniffer的检测功能

• 提示缺少注释
  

• 提示方法名没有按驼峰法命名
  

• 提示逗号应该有一个空格
  

试了下，，，带波浪线的都是phpcs提示的，那要调整的话就太多了，，再看……

参考资料

1. Set Up PHP CodeSniffer for Local Development
2. PHP_CodeSniffer官方下载地址