79

我TestMyClass.php在同一个文件（单元测​​试类）中有两个类定义，PHP Code Sniffer 抱怨每个类都必须单独在一个文件中。我怎样才能抑制这个警告？

class MyClassImpl implements MyInterface
{
    // ...
}

class MyClassTest extends \PHPUnit_Framework_TestCase
{
    // ...
}
4

4 回答 4

108

您可以使用注释让 PHP_CodeSniffer 忽略文件中的特定文件或行：https ://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-files-and-folders

在这种情况下，错误将在您的第二个类定义中生成，因此您必须像这样编写第二个定义：

// @codingStandardsIgnoreStart
class MyClassTest extends \PHPUnit_Framework_TestCase
{
    // @codingStandardsIgnoreEnd
    // ...
}

但是，如果不应该检查整个文件，您也可以选择忽略整个文件，使用 @codingStandardsIgnoreFile 注释或在命令行上指定排除项（有关信息，请参阅上一个链接）。

如果您发现自己经常这样做并且不想在代码中添加注释，您还可以创建自己的自定义编码标准。假设您现在正在使用 PSR2 标准，您将创建一个 XML 文件（例如 mystandard.xml）并包含以下内容：

<?xml version="1.0"?>
<ruleset name="MyStandard">
 <description>My custom coding standard.</description>
 <rule ref="PSR2" />
 <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
   <severity>0</severity>
 </rule>
</ruleset>

然后像这样运行 PHP_CodeSniffer：phpcs --standard=/path/to/mystandard.xml /path/to/code

拥有自己的规则集可以让您做很多事情，包括更改错误消息、更改消息的严重性或类型，包括来自其他标准的检查以及设置全局忽略规则。更多信息在这里：https ://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml

于 2013-04-17T23:09:13.833 回答
69

使用以下注释，您可以忽略您想要的文件的任何部分。

忽略文件的所有嗅探：

<?php
// phpcs:ignoreFile

仅忽略当前行和下一行：

// phpcs:ignore
public function store($myArray)

忽略当前行：

public function store($myArray) // phpcs:ignore

忽略文件中的一定数量的行：

// phpcs:disable
public function store($myArray): void
{
    if (count($myArray) > 3) {
        // Humongous amount of legacy code you don't want to look at
    }

    return;
}
// phpcs:enable

使用// phpcs:ignore和 // phpcs:disable您还可以指定要禁用的消息、嗅探、类别或标准，例如：

// phpcs:ignore Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed
$foo = [1,2,3];

如果您想了解更多关于此主题的信息，可以访问wiki。一些例子取自那里。

于 2019-11-27T15:03:50.557 回答
26

该@codingStandards语法自版本起已弃用3.2.0，请phpcs改用。

一些例子：

// phpcs:disable
// phpcs:ignore
// phpcs:enable

有关更多信息，请参阅此页面：https ://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-parts-of-a-file

于 2018-04-23T13:25:39.943 回答
5

尽管我喜欢最佳答案，但如果您不关心特定文件，我也会建议您使用此答案。

运行此命令：

phpcs --config-set show_warnings 0

如此处所示： https ://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options#hiding-warnings-by-default

关于以这种方式设置配置的注意事项是，如果您删除供应商文件夹或更新库，它们将被清除，您将不得不再次设置它们。

于 2019-12-17T13:07:00.163 回答