Question

我无法关闭CheckStyle错误

SummaryJavadoc: First sentence of Javadoc is missing an ending period.

根据this thread，解决方法是

<module name="JavadocStyle">
   <property name="checkFirstSentence" value="false"/>
</module>

但是，在我将它放回去之后，仍然没有得到错误。

根据该消息，错误出现在 SummaryJavadoc 中，而不是 JavadocStyle 中。因此，我尝试将该属性放入SummaryJavadoc中：

   <module name="SummaryJavadoc">
        <property name="checkFirstSentence" value="false"/>
        <property name="forbiddenSummaryFragments"
         value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
    </module>

但是那完全破坏了CheckStyle，所以我也不能放在那儿。

Answer 1

将checkFirstSentence设置为false可以删除First sentence of Javadoc is missing an ending period的{{1}}违规。要从JavadocStyle中删除First sentence of Javadoc is missing an ending period，请将SummaryJavadoc设置为空。

period

Answer 2

我解决了它-正如链接线程所建议的，有一个步骤2：完全删除SummaryJavadoc部分。 这是解决方案的一部分。我认为答案的一部分无关紧要，只是一个偏好。

因此，有2个步骤可以消除Checkstyle中的First sentence of Javadoc is missing an ending period错误：

STEP 1

添加

<module name="JavadocStyle">
   <property name="checkFirstSentence" value="false"/>
</module>

第2步

删除或注释掉整个SummaryJavadoc部分：

    <!-- 
    <module name="SummaryJavadoc">
        <property name="forbiddenSummaryFragments"
         value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
    </module>
     -->

Checkstyle：如何关闭“ SummaryJavadoc：Javadoc的第一句话缺少结束时间。”

2 个答案: