如何使用注释来抑制PHPCS警告？

Question

我的 TestMyClass.php 文件中有两个类定义（单元测试类），而 PHP Code Sniffer 抱怨每个类必须放在自己的文件中。我该如何抑制这个警告？

class MyClassImpl implements MyInterface
{
    // ...
}

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

- gremo

Answer 1

以下是您可以忽略文件中任何部分的注释。

忽略文件中的所有嗅探：

<?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，您还可以指定要禁用的消息、sniff、类别或标准，例如：

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

如果您想了解更多关于这个主题的信息，您可以访问Wiki。其中一些例子来自那里。

- piscator

Answer 2

你可以使用注释来让 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

- Greg Sherwood

---

跳过测试文件给你加1！或者，也许你可以使用PHPUnitStandard来处理它们 :-) - cmbuckley

从文档中可以看到，你还可以使用@codingStandardsIgnoreLine注释来忽略单独的一行代码。该注释将忽略包含该注释及其下一行的代码。 - JSmitty

请注意，语法已更改。 @codingStandards 注释已被弃用，并替换为 //phpcs:disable 等。上面的原始链接仍然有效，并讨论了新语法。 - Spudley

Answer 3

@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

- Will

Answer 4

尽管我喜欢顶部的答案，但如果您不关心特定的文件，我也建议使用这个。

运行此命令： phpcs --config-set show_warnings 0

如下所示： https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options#hiding-warnings-by-default 关于以这种方式设置配置的说明是，如果您删除供应商文件夹或更新库，则它们将被清除，您将不得不重新设置它们。

- Brad