如果javadoc评论为空,你可以帮我配置Checkstyle来警告我吗?
在下列情况下,Checkstyle dest不会警告我(javadoc评论完全缺失):
/**
*
*/
public enum MyType{ EQUALS }
我已查看文档here,但我看不到与此问题相关的任何内容。
答案 0 :(得分:0)
为此,您可以使用Style Javadoc
部分中的Javadoc Comments
Checkstyle模块。来自Checkstyle documentation on Style Javadoc:
验证Javadoc注释以帮助确保它们格式正确。该 执行以下检查:
- 确保第一句以正确的标点符号结束(默认情况下为句点,问号或感叹号)。的Javadoc 自动将第一个句子放在方法摘要表中 和索引。没有适当的标点符号,Javadoc可能会出错。 符合{@inheritDoc}标签的所有项目均可免除此项 要求。
- 检查没有任何描述的Javadoc语句的文本。这包括完全空的Javadoc和只有Javadoc @param和@return等标签。
请务必选中checkEmptyJavadoc
复选框: