使用 Checkstyle 检查注释/Javadoc 的字数

Question

是否可以设置一个检查样式规则，该规则将计算来自通信的单词数，然后在单词数低于定义的限制时显示问题。我搜索了checkstyle Javadoc属性，但没有找到有用的东西。

例如：

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

评论包含超过 3 个单词，并且是正确的。但是，如果字数低于限制，checkstyle 应将其标记为问题。

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

Answer 1

没有标准的 Checkstyle 检查来执行此操作。 但是，您可以编写自己的：

• "写作支票"页面提供了介绍。

• 您可以使用 ...checks.javadoc 包中类的源代码来帮助您了解如何处理注释。

---

评论：字数统计不是衡量javadoc质量的有效标准。 对那些在上下文中明显不言而喻的含义的事物进行简洁或最少的描述并不是坏的风格。 此外，计算单词只会鼓励人们用无用或无意义的东西填充他们的 javadoc;例如"亚达，亚达，亚达"：-）。

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