Checkstyle：如何关闭 "SummaryJavadoc: First sentence of Javadoc is missing an ending period."

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

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

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

第 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>
     -->

Answer 2

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

$ cat TestClass.java
public class TestClass {
    /** Example */
    void method() {
    }
}

$ cat TestConfig.xml
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
          "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
    <property name="charset" value="UTF-8"/>

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

$ java -jar checkstyle-8.20-all.jar -c TestConfig.xml TestClass.java
Starting audit...
Audit done.

Checkstyle：如何关闭 "SummaryJavadoc: First sentence of Javadoc is missing an ending period."

Checkstyle: How to turn off "SummaryJavadoc: First sentence of Javadoc is missing an ending period."

javadoc

checkstyle