使用 Checkstyle 检查 Comments/Javadoc 个单词

Question

是否可以设置一个 checkstyle 规则来计算评论中的字数，然后在字数低于定义的限制时显示问题。我搜索了 checkstyle Javadoc 属性，但没有找到有用的东西。

例如：

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

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

如果可能的话，如果将规则应用于评论的每个部分（return 的描述、参数、方法描述等），那就太好了。

Answer 1

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

• "Writing Checks" 页面提供了介绍。

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

---

评论：字数不是衡量 javadoc 质量的有效方法。对意义在上下文中明显不言而喻的事物进行简洁或最少的描述并不是一种糟糕的风格。此外，计算字数只会鼓励人们用无用或无意义的东西来填充他们的 javadoc；例如 "yadda, yadda, yadda" :-).

如果您想对 javadoc 质量做出有意义的评估，需要有人阅读它们。