列出没有Javadocs的所有类

有没有简单的方法来分析源代码，列出没有Javadoc的类的数量

作为技术债务练习的一部分，我想列出所有这些文件，并在团队中共享该列表，让原始作者编写它们

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

更新。。。

---

因此，默认情况下会创建空的javadoc，但是我们的开发人员没有将它们填充得太多。我希望能够看到所有的类，没有任何描述在类级别的文档。我不太在意方法。

一个简单的方法就是使用

下载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>

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

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

有很多选择，您可以在以下内容中看到：

---

您的问题似乎比这复杂得多，因为如何定义“has javadoc”？在类级别或者方法级别上有注释就足够了吗。如果您有一个自动生成的javadoc，比如/@author-Alex/，该怎么办。从技术上讲，它是一个javadoc，但在它中没有任何内容。我们在sonar cube上有这样的报告，尽管我记得它显示了许多未记录的公共方法。说到SonarQube，为什么不将它添加到您的持续集成堆栈中呢？谢谢。。更新上述问题更新了我的答案，它是否满足了您的需求？这种方法的问题是intellij正在以bob于2015年8月18日创建的格式/***为我们自动生成JDOC。*/这显示为一个javadoc，尽管它几乎毫无用处。我需要找到那些没有更多“created by”行信息的类。如果javadoc是“invalid”，您可以将Checkstyle配置为抛出错误。请在查看文档。例如，您可以激活

NonEmptyAtclauseDescription

模块（不包含@param或@return的javadocs将被拒绝）或

SummaryJavadocCheck

，并使用禁止的文本“Created by*”（包含该文本的javadocs将被拒绝）。

<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.