分类: PHP
2013-03-21 10:39:13
今天跟拯明还有两位61期的妹纸聊了聊,谈到了代码规范,我也大概讲了一些需要注意的点,可是觉得还不够仔细,这里分享一下最近才开始使用的工具,当然代码规范可是一直对自己要求很高哦,哈哈,好了不啰嗦了,下面的内容是从网上复制的,刚刚答应拯明写一篇,可是刚刚发现这篇讲得还是挺好的就不费劲了(程序员都很懒惰),来源:http://blog.csdn.net/xinhaozheng/article/details/3324796
认识PHP_CodeSniffer
PHP_CodeSniffer是PEAR中的一个用PHP5写的用来检查嗅探PHP代码是否有违反一组预先设置好的编码标准的一个包,它是确保你的代码简洁一致的必不可少的开发工具,甚至还可以帮助程序员减少一些语义错误。
安装PHP_CodeSniffer
如果你的WEB服务器上已经安装了PHP和PEAR,那么直接运行下列命令就可以安装PHP_CodeSniffer。
$
pear install
PHP_CodeSniffer
安装后,你可以在命令行敲入命令phpcs来调用PHP_CodeSniffer检查代码,默认情况下,PHP_CodeSniffer采用的是PEAR的
编码标准;你现在就可以尝试一下用它来检查你的代码是否符合编码标准,如:
$
phpcs /path/to/code/yourfile.php
如果要检查一个目录,则应使用下列命令:
$ phpcs
/path/to/code
PHP_CodeSniffer的使用方法
使用PHP_CodeSniffer的主程序是phpcs,它的具体使用方法我们可以通过在命令行运行下列命令来获得phpcs的相关参数及
相应的使用信息。
$
phpcs -h
使用PHP_CodeSniffer检查文件或文件目录
使用PHP_CodeSniffer的最简单的方式是直接给phpcs传递一个路径。如果路径是指向一个文件目录,那么PHP_CodeSniffer会检查该文件目录及其也有了目录中的所有文件。如果你不希望检查所有子目录,你可以加上-l(locally)参数,这样它只会检查当前目录中的文件。$
phpcs /path/to/code/myfile.inc
$ phpcs /path/to/code/my_dir 你也可以同时指定多个文件或目录以供PHP_CodeSniffer检查。
$
phpcs /path/to/code/myfile.inc
/path/to/code/my_dir控制PHP_CodeSniffer输出的检查结果
PHP_CodeSniffer在检查完文件之后会给你一个错误报告,列出所有文件中违反编码标准的错误和警告信息。
如果你不想在输出的检查结果中包含警告信息(WARNING),你可以给phpcs加上-n参数。 默认情况下,检查完文件后PHP_CodeSniffer会输出所有的错误和警告信息的列表,通常是很长的,尤其是在检查比较多的文件的时候,列表很长而且速度很快,你根本看不到什么。这个时候你可能只需要知道每个文件各自都有多少个错误和警告信息,你可以使用
--report=summary 参数。$ phpcs --report=summary /path/to/code
此外,PHP_CodeSniffer还可以将检查结果以xml,csv和类似于Checkstyle输出结果的格式输出,这样方便你在你自己的脚本中对检查结果进步分析处理或者提供给支持Checkstyle的应用程序处理。
$ phpcs
--report=checkstyle /path/to/code
$ phpcs
--report=csv /path/to/code
$ phpcs
--report=checkstyle /path/to/code
注:在以csv格式输出检查结果时,输出结果的第一行指示了检查结果信息的顺序(即哪一列对就着什么信息)。
另外,PHP_CodeSniffer在处理过程中不输出任何信息直到处理结束输出检查结果。在处理比较多的文件时,有可能需要等待比较长的时间,如果你想知道在此过程中发生了什么事情,你可以在执行PHP_CodeSniffer时带上-v参数,这样PHP_CodeSniffer在处理过程中会输出当前正在处理的文件的名称,所包含的行数和标识符的个数。
$ phpcs
/path/to/code/CodeSniffer -v
设置PHP_CodeSniffer的相关配置选项
PHP_CodeSniffere有提供一些配置选项,某些编码标准只有在设置了配置选项后才能使用。要设置一个HP_CodeSniffer配置选项,可以使用:
$ phpcs
--config-set
原文地址: