PHP CodeSniffer是PEAR中的一个用PHP5写的一个PHP的代码风格检测器,它根据预先设定好的PHP编码风格和规则,去检查应用中的代码风格情况是否有违反一组预先设置好的编码标准,内置了ZEND,PEAR的编码风格规则,当然也支持自己定制。PHP CodeSniffer 是确保代码简洁一致的必不可少的开发工具,甚至还可以帮助程序员减少一些语义错误。
参考文章:https://confluence.jetbrains.com/display/PhpStorm/PHP+Code+Sniffer+in+PhpStorm
期初使用
composer global require "squizlabs/php_codesniffer=*"
后续操作一直不顺利,后来改用pear扩展安装。。完整记录流程如下(IDE:JetBrains PhpStorm 2017.2.2 x64):
- 安装PHP Code Sniffer
我们用PEAR(即:php的扩展和应用仓库)安装PHP Code Sniffer。(请确保已安装composer,教程很多,这里就不在赘述啦)添加中国Packagist 镜像源:
composer config -g repo.packagist composer http://packagist.phpcomposer.com
- 下载PEAR文件,右键连接,选择“连接另存为”go- pear.phar即可。
- 安装REAR: 打开命令行工具(开始->运行->cmd,cmd以管理员模式运行,切换到php服务器的目录。(我的phpstudy举例:F:\phpStudy\php\php-7.1.10-nts)
直接回车:
输入 Y
回车:
- 安装PHP Code Sniffer
pear install PHP_CodeSniffer
安装完毕;查看目录下多了个pear目录:
安装到Phpstorm中
-
打开Phpstorm的设置页(
File->Setting
或者Ctrl+Alt+s
),到Code Sniffer页Setting->Languages and Frameworks->PHP->Code Sniffer
。 -
在 PHP Code Sniffer (phpcs) Path 选项挑选 CodeSniffer 的执行文件,在 PEAR 根目下(F:\phpStudy\php\php-7.1.10-nts
\phpcs.bat
)。按下 Validate,如果下面出现绿色的字则表示成功。 -
Setting->Editor->Code Style->Inspections->PHP->Code Sniffer validation
勾选上,然后在右边的 Coding standard 按下刷新按鈕(选择PSR2既可),成功的话,点击下拉按钮就会有可供选择的标准。
以上配置基本OK了,现在随便打开一个php文件看效果吧!