如何在本地关闭评论中的 phpmd 规则？

Question

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

Answer 1

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

在函数文档块中，您可以添加@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>工作中的链接名称之一。