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

时间:2015-04-27 19:43:47

标签: php phpmd

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

1 个答案:

答案 0 :(得分:4)

PHPMD调用此Warning Suppression。警告抑制粒度是一个函数范围的粒度。注释将添加到函数/类docblock中,因此适用于该docblock的范围。

在功能文档块中,您可以添加@SuppressWarnings(unused)关键字。

来自examples

<?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>the rules doc工作中的链接名称之一。