PHP_CodeSniffer
前言
原文地址
一个开发团队统一的编码风格,有助于他人对代码的理解和维护,对于大项目来说尤其重要。
PHP_CodeSniffer是PEAR中的一个用PHP5写的用来检查嗅探PHP代码是否有违反一组预先设置好的编码标准的一个包,它是确保你的代码简洁一致的必不可少的开发工具,甚至还可以帮助程序员减少一些语义错误。
安装
安装 pear
在安装完 pear 之后,就可以安装 php_CodeSniffer 了,继续在 cmd 中输入:
pear install PHP_CodeSniffer
等待安装完成,安装完成后php根目录下回出现以下两个文件:
按照下图依次打开文件夹,在看如下目录结构:
在php->pear->PHP->CodeSniffer->Standards
中可以看到一些 PHP 的规范,Generic 是通用规范。
现在我们就可以使用这些规范来检测我们的 PHP 代码了,先说说在命令行中如何使用。
我们可以使用phpcs -h
来看看使用帮助:
phpcs -h
看到的如下:
这里我只简单的说明如何检查单个文件或整个文件目录:
phpcs -n F:\Hg\web\application\controllers\ //检测文件目录
phpcs -n F:\Hg\web\application\controllers\home_controller.php //检测单个文件
看到如下结果(单个文件):
这样,我们就可以根据这些错误信息去修改我们的代码,使其符合规范。
我们可以指定使用某一个规范进行检测,方法如下:
1 phpcs -n --standard=Zend F:\Hg\web\application\controllers\
不指定标准,会使用 PHP 通用规范 Generic。