如何关闭CheckStyle的SummaryJavadoc首句无句号检查报错？

看来你在处理CheckStyle的SummaryJavadoc规则时踩了个小坑，我来帮你理清楚问题出在哪，以及怎么解决：

首先，你一开始尝试用JavadocStyle模块的checkFirstSentence属性，但这个属性只对JavadocStyle自身的首句检查生效，而你的报错明确来自SummaryJavadoc模块，所以这个配置自然没效果。

然后你直接给SummaryJavadoc加checkFirstSentence属性导致崩溃，原因很简单——SummaryJavadoc根本没有这个属性，CheckStyle无法识别非法的配置项，自然就启动失败了。

正确的解决方案 #

要关闭SummaryJavadoc的「首句缺少结尾句号」检查，同时保留你需要的其他规则（比如禁止那些冗余的摘要开头），你需要用SummaryJavadoc专属的配置属性：allowMissingEndingPeriod。把它设为true就能允许首句不带结尾句号，同时不会影响其他规则。

修改后的配置应该是这样：

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

这个配置既保留了你想要的禁止冗余摘要片段的检查，又关闭了首句句号的强制要求，而且不会导致CheckStyle崩溃。

内容的提问来源于stack exchange，提问作者gene b.