使用Checkstyle检查评论/ Javadoc字数

时间:2015-02-03 10:33:16

标签: java comments javadoc checkstyle

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

例如:

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

评论包含3个以上的单词并且是正确的。但是如果单词数量不足,checkstyle应该将其标记为问题。

如果可以,如果将规则应用于注释的每个部分(返回描述,参数,方法描述等),那将会很棒。

1 个答案:

答案 0 :(得分:2)

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

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

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


评论:字数不是衡量javadoc质量的有效方法。对于其意义在上下文中明显不言自明的事物而言,对其进行简洁或最小化的描述并不是不错的风格。计算单词只会鼓励人们用无用或无意义的东西来填充他们的javadoc;例如“yadda,yadda,yadda”: - )。

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