java - 使用 Checkstyle 检查评论/Javadoc 字数

Question

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

例如:

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

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

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

Answer 1

没有标准的 Checkstyle 检查可以做到这一点。不过你可以自己写:

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

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

<小时/>

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

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