列出所有没有Javadocs的类

Question

是否有任何简单的方法来分析源代码以列出没有任何javadocs的类的数量？

作为技术债务练习的一部分,我想列出所有这些文件,并在团队中分享列表,让原作者写出来.

注意:我们使用gradle作为构建系统

更新...所以默认情况下会创建空的javadocs,但是我们的开发人员已经充满了它们.我希望能够在类级别的doc中查看所有没有任何描述的类.我不太关心方法.

Answer 1

一种简单的方法是使用Checkstyle.

下载jar文件并创建一个配置XML文件(javadoc_checks.xml),如下所示:

<module name="Checker">
    <module name="TreeWalker">
        <module name="JavadocType"/>
        <module name="JavadocMethod"/>
        <module name="JavadocVariable"/>
        <module name="JavadocStyle"/>
    </module>
</module>

现在运行以下命令(假设所有内容都在同一目录中并src 包含您的代码):

java -jar checkstyle-6.9-all.jar -c javadoc_checks.xml src/

例如,如果您只想检查类和接口缺少的javadoc,那么您只需要在配置XML中使用它:

<module name="Checker">
    <module name="TreeWalker">
        <module name="JavadocType"/>
    </module>
</module>

输出将是这样的:

C:\src\com\example\Test.java:137: Javadoc comment missing.
C:\src\com\example\Test1.java:3: Javadoc comment missing.
C:\src\com\example\Test2.java:12: Javadoc comment missing.

有很多选项,您可以在以下位置看到它们:

http://checkstyle.sourceforge.net/config_javadoc.html

http://checkstyle.sourceforge.net/cmdline.html