如何在注释中本地关闭phpmd规则？

Question

如何在本地为几行禁用单个phpmd规则，然后重新启用规则，例如unusedcode

Answer 1

PHPMD将此称为警告抑制。警告抑制粒度是一个函数范围的粒度。注释被添加到函数/类docblock中，因此适用于该docblock的作用域。

在函数doc块中，可以添加@SuppressWarnings(unused)关键字。

从他们的示例

<?php
/**
 * Suppress all rules containing "unused" in this
 * class
 *
 * @SuppressWarnings("unused")
 */
class Bar {
    private $unusedPrivateField = 42;
    public function foo($unusedFormalParameter = 23)
    {
        $unusedLocalVariable = 17;
    }
    private function unusedPrivateMethod() {
    }
}    

规则名称没有显式列出以供使用，因此在有效名称上有一些注释：

关于警告名称的一些注释：

• unused是规则集runusedcode报告的规则的抑制名称。
• PHPMD是一个顶级名称，可以抑制块的所有phpmd警告。
• PHPMD.<rulename>，其中<rulename>是规则博士工作的链接名称之一。