intellij-idea - IntelliJ - 查找未记录的公共方法

Question

使用 IntelliJ IDEA 15，我如何找到缺少 javadoc 的公共方法，从而导致 SonarQube metric Public Documented API 的减少，如此处所示？

Answer 1

IntelliJ 具有检查代码的能力。

1.调整检查设置

为了识别缺少的公共文档，首先启用 issue Declaration has Javadoc questions。您可以通过打开 IDE Settings 并选择Editor -> Inspections来执行此操作。在右侧菜单中选择Java -> Javadoc issues -> Declaration has Javadoc questions。激活这个问题。

再次在右下角，您将看到此问题的一些选项。确保选项卡Method的Scope设置为public。还要检查忽略简单的属性访问，因为您不想被告知缺少文档的 getter 和 setter。

单击确定保存。

2.检查代码

在 IntelliJ 的顶部菜单栏中打开Analyze -> Inspect Code...，选择要检查的数量并单击OK运行它。在检查结果中查找Javadoc 问题 -> 声明有 Javadoc 问题。那些声明Required Javadoc 不存在的问题正是您要寻找的。