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

将 checkFirstSentence 设置为 false 可以消除 Javadoc第一句缺少结束句点 对于 JavadocStyle 的违规情况。要从 SummaryJavadoc 中删除 Javadoc 第一个句子缺少结束句点，请将 句点 设置为空。

$ 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.