使用Checkstyle检查注释/Javadoc字数

使用Checkstyle检查注释/Javadoc字数,java,comments,javadoc,checkstyle,Java,Comments,Javadoc,Checkstyle,是否可以设置一个checkstyle规则,该规则将计算一个命令中的字数,然后在字数低于定义的限制时显示问题。我搜索了checkstyle属性,但没有找到有用的内容 例如: /** * Stores the database connection. */ private Connection mConnection; 评论包含3个以上的单词,应该是正确的。但是如果字数低于限制,checkstyle应该将其标记为问题 如果这是可能的,那么将规则应用于注释的每一部分(返回描述、参数、方法描述等)

是否可以设置一个checkstyle规则,该规则将计算一个命令中的字数,然后在字数低于定义的限制时显示问题。我搜索了checkstyle属性,但没有找到有用的内容

例如:

/**
 * Stores the database connection.
 */
private Connection mConnection;
评论包含3个以上的单词,应该是正确的。但是如果字数低于限制,checkstyle应该将其标记为问题


如果这是可能的,那么将规则应用于注释的每一部分(返回描述、参数、方法描述等)将非常好。

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

  • 这一页提供了一个介绍

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


注释:字数不是衡量javadoc质量的有效指标。对于那些在上下文中意义显而易见的事物,简洁或最少的描述是一种不错的风格。此外,计算单词只会鼓励人们用无用或无意义的东西填充javadoc;e、 g“雅达,雅达,雅达”:-


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

不要尝试。这种检查只能由人进行。除非您对开发人员进行培训并手动检查文档,否则它永远不会生成更好的文档。我的两分钱。我重新考虑了最初的想法,我想你们两个是对的。我将更多地关注代码审查,而不是计算字数,这只会给出一个关于数量的声明。