排除“类x缺少文档注解”的PHP_CodeSniffer规则

31moq8wy  于 2023-02-18  发布在  PHP
关注(0)|答案(2)|浏览(85)

如何配置Codesniffer的自定义ruleset.xml配置以排除对错误"Missing doc comment for class className"的检查?

4xrmg8kj

4xrmg8kj1#

首先,您必须找出确切规则的名称,在控制台中运行codesniffer-它是一个以点分隔的名称,例如“FileDocBlock.FileDocBlockMissing”。然后,在您的ruleset.xml中插入以下内容

<rule ref="NAME.OF.THE.RULE">
    <severity>0</severity>
</rule>
ztigrdn8

ztigrdn82#

首先,您需要确定导致错误的规则。
您可以通过使用-s选项运行phpcs来完成此操作。

php -s index.php
1 | ERROR   | [ ] Missing doc comment for class x (Squiz.Commenting.ClassComment.Missing)

现在你知道你的目标规则,你可以禁用它在你的phpcs.xml文件如下:

<?xml version="1.0"?>
<ruleset name="WordPress Theme">
  <rule ref="WordPress">
    <exclude name="Squiz.Commenting.ClassComment"/>
  </rule>
</ruleset>

如您所见,我使用的是WordPress Coding Standards,它包含了所讨论的规则,但对您来说可能会有所不同。
在这之后,错误就消失了。
参考:

相关问题