README

PHP_CodeSniffer是一个PHP5脚本，它将PHP、JavaScript和CSS文件进行标记化，以检测违反定义的编码标准的情况。它是确保您的代码保持整洁和一致性的关键开发工具。它还可以帮助防止开发者犯的一些常见语义错误。

要求

PHP_CodeSniffer需要PHP版本5.1.2或更高版本，尽管个别检查可能需要额外的需求，例如外部应用程序和脚本。请参阅配置选项手册页面以获取这些需求的列表。

由于使用了垂直空白字符，SVN预提交钩子需要PHP版本5.2.4或更高版本。

安装PHP_CodeSniffer的最简单方法是使用PEAR安装程序。这将使phpcs命令立即可供使用。要使用PEAR安装程序安装PHP_CodeSniffer，请首先确保您已经安装了PEAR，然后运行以下命令

pear install PHP_CodeSniffer

如果您不想安装PEAR，您可以从GIT检出下载PHP_CodeSniffer源代码并直接运行phpcs命令

git clone git://github.com/squizlabs/PHP_CodeSniffer.git
cd PHP_CodeSniffer
php scripts/phpcs -h

PHP_CodeSniffer的文档可在PEAR手册中找到。

有关即将推出的功能和版本的信息可在Squiz Labs博客上找到。

如果您为PHP_CodeSniffer贡献代码，请确保它符合PEAR编码标准，并且PHP_CodeSniffer单元测试仍然通过。最简单的贡献方式是在仓库检出或您自己的分支上工作，而不是在安装的PEAR版本上。如果您这样做，您可以运行以下命令来检查是否已准备好提交

cd PHP_CodeSniffer
php scripts/phpcs --ignore=*/tests/* . -n

这应该不会输出任何内容，表明没有PEAR编码标准错误。然后

phpunit tests/AllTests.php

这应该不会出现失败或错误。您可以忽略任何跳过的测试，因为这些是针对外部工具的。

可以通过PEAR错误跟踪器提交错误报告和功能请求。