如果javadoc注解为空，您能帮我配置checkstyle来警告我吗？在以下情况下，checkstyle dest不会警告我（javadoc注解完全丢失）：
/** * */ public enum MyType{ EQUALS }
我已经检查了这里的文档，但我看不到任何与此问题相关的内容。
aurhwmvo1#
为此，您可以使用 Style Javadoc 中的checkstyle模块 Javadoc Comments 部分。在样式javadoc的checkstyle文档中：验证javadoc注解以帮助确保其格式良好。执行以下检查：确保第一个句子以正确的标点符号结尾（默认情况下是句点、问号或感叹号）。javadoc会自动将第一句话放在方法摘要表和索引中。如果没有正确的标点符号，javadoc的格式可能不正确。符合{@inheritdoc}标记的所有项目都不受此要求的限制。检查没有任何描述的javadoc语句的文本。这包括完全空的javadoc和只有@param和@return等标记的javadoc。一定要检查 checkEmptyJavadoc 复选框：
Style Javadoc
Javadoc Comments
checkEmptyJavadoc
1条答案
按热度按时间aurhwmvo1#
为此，您可以使用
Style Javadoc中的checkstyle模块Javadoc Comments部分。在样式javadoc的checkstyle文档中：验证javadoc注解以帮助确保其格式良好。执行以下检查：
确保第一个句子以正确的标点符号结尾（默认情况下是句点、问号或感叹号）。javadoc会自动将第一句话放在方法摘要表和索引中。如果没有正确的标点符号，javadoc的格式可能不正确。符合{@inheritdoc}标记的所有项目都不受此要求的限制。
检查没有任何描述的javadoc语句的文本。这包括完全空的javadoc和只有@param和@return等标记的javadoc。
一定要检查
checkEmptyJavadoc复选框：