Checkstyle 未检测到空的 javadoc 注释答案

【问题标题】：Checkstyle does not detect empty javadoc commentCheckstyle 未检测到空的 javadoc 注释
【发布时间】：2018-04-13 01:56:51
【问题描述】：

能否请您帮我配置 Checkstyle 以在 javadoc 注释为空时警告我？

Checkstyle dest 在以下情况下不会警告我（javadoc 注释完全丢失）：

/**
 *
 */
public enum MyType{ EQUALS }

我已经检查了文档here，但我没有看到任何与此问题相关的内容。

【问题讨论】：

嗯，你配置 Checkstyle 来检查这个了吗？您希望触发哪项检查？
我已经检查了文档，但我看不到与此问题相关的任何内容。我不知道我需要在配置文件中设置哪个属性。
不是丢失，是空的。
你说得对，我已经更新了我的问题。知道如何检查空的 javadoc 注释吗？

标签： java maven javadoc checkstyle

【解决方案1】：

为此，您可以使用Javadoc Comments 部分中的Style Javadoc Checkstyle 模块。来自 Checkstyle documentation on Style Javadoc：

验证 Javadoc cmets 以帮助确保它们格式正确。这执行以下检查：

确保第一句以正确的标点符号结尾（默认为句号、问号或感叹号）。 Javadoc 自动将第一句放在方法摘要表中和索引。如果没有正确的标点符号，Javadoc 可能格式不正确。所有符合 {@inheritDoc} 标记的项目都不受此限制要求。

检查没有任何描述的 Javadoc 语句的文本。这包括完全空的 Javadoc 和只有 @param 和 @return 等标签。

确保选中checkEmptyJavadoc 复选框：

【讨论】：