javadoc和@param之间没有空行时如何使Checkstyle失败

Question

例如，我有下面的代码。我想让checkstyle抱怨，因为我的顶级javadoc注释和@子句之间没有空白行。

/**
 * This line or the next line should fail checkstyle.
 * @param param is essential
 * @throws Exception is thrown when something bad happens
 */

将javadoc更改为以下样式时，Checkstyle不应该抱怨：

/**
 * This line or the next line should no longer fail.
 * 
 * @param param is essential
 * @throws Exception is thrown when something bad happens
 */

我尝试使用@Mureinik的建议，但它并不抱怨我在第一段和@子句之间缺少空白行。我验证了eclipse已识别出我在下面的屏幕截图中启用了JavadocParagraph。

<module name="JavadocParagraph"/>

Answer 1

JavadocParagraph检查应确保做到这一点。只需将以下内容添加到您的checkstyle配置中即可：

<module name="JavadocParagraph"/>