检查注释/Javadoc字数与Checkstyle

Question

是否可以设置一个校验样式的规则，该规则将计算一个注释中的单词数，然后显示一个问题，如果字数低于定义的限制。我搜索了校验样式的Javadoc属性，但没有找到有用的东西。

例如：

/**
 * Stores the database connection.
 */
private Connection mConnection;

该评论包含3个以上的词，并将是正确的。但是，如果字数不超过这个限制，校验风格就会把它标记为一个问题。

如果这是可能的话，如果将规则应用于注释的每个部分(返回描述、参数、方法描述等)，那就太好了。

Answer 1

没有标准的Checkstyle检查可以做到这一点。但是，您可以编写自己的：

• “书面支票”页面提供了一个介绍。
• 您可以使用...checks.javadoc 套餐中的类的源代码来帮助您理解如何处理注释。

注释:单词计数不是衡量javadoc质量的有效方法。对其意义在上下文中明目张胆地不言自明的事物进行简洁或最小的描述并不是不好的风格。此外，计算单词只会鼓励人们用无用或无意义的东西来填充他们的javadocs；例如"yadda，yadda，yadda“:-)。

如果您想对javadoc质量进行有意义的评估，那么人类需要阅读它们。