Php Codesniffer 应该忽略大写字母和句号

Question

我正在为现有项目实施 PHPCS。我想检查函数是否有文档块。

我目前正在使用以下规则：

    <rule ref="Squiz.Commenting.FunctionComment" />
    <rule ref="Squiz.Commenting.FunctionCommentThrowTag" />
    <rule ref="Squiz.Commenting.VariableComment" />
    <rule ref="Squiz.Commenting.DocCommentAlignment"/>
    <rule ref="Generic.Files.LineLength">
        <properties>
            <property name="absoluteLineLimit" value="120"/>
            <property name="lineLimit" value="120"/>
        </properties>
    </rule>
    <!-- Ban some functions -->
    <rule ref="Generic.PHP.ForbiddenFunctions">
        <properties>
            <property name="forbiddenFunctions" type="array">
                <element key="print" value="echo"/>
                <element key="var_dump" value="null"/>
                <element key="dd" value="null"/>
                <element key="dump" value="null"/>
                <element key="echo" value="null"/>
                <element key="print_r" value="null"/>
                <element key="var_export" value="null"/>
            </property>
        </properties>
    </rule>

但是我遇到了很多问题，参数注释应该以大写字母开头并以句号结尾。

如何降低关于大写字母和句号的规则

编辑：目前代码块也想对齐参数。这会在 @param array 和 $parameter 之间产生很多丑陋的空白。我也可以在 phpcs 和 phpcbf 中删除这条规则吗？

Answer 1

运行带有 -s 命令行参数的 PHPCS，因此您可以在每条消息旁边看到错误代码。然后，您可以将这些特定消息的严重性设置为 0，从而在您的规则集中排除这些特定消息。

在这种特定情况下，您可能希望将这 4 个排除项添加到您的规则集中：

<rule ref="Squiz.Commenting.FunctionComment.ParamCommentNotCapital">
    <severity>0</severity>
</rule>
<rule ref="Squiz.Commenting.FunctionComment.ParamCommentFullStop">
    <severity>0</severity>
</rule>
<rule ref="Squiz.Commenting.FunctionComment.SpacingAfterParamType">
    <severity>0</severity>
</rule>
<rule ref="Squiz.Commenting.FunctionComment.SpacingAfterParamName">
    <severity>0</severity>
</rule>

Php Codesniffer 应该忽略大写字母和句号

Php Codesniffer Should ignore Capital letter and full stop

php

codesniffer

phpcodesniffer

phpcs