IntelliJ - 查找未记录的 public 方法

IntelliJ - Find undocumented public methods

使用 IntelliJ IDEA 15,我如何找到 public 缺少 javadoc 的方法,从而导致 SonarQube 指标下降 Public 已记录 API如图?

IntelliJ 能够检查代码

1。调整检查设置

为了识别缺失的public文档,首先启用问题声明有Java文档问题。您可以通过打开 IDE 设置和 select 编辑器 -> 检查 来完成此操作。在右侧菜单select Java -> Javadoc issues -> Declaration has Javadoc problems。激活此问题。

同样在右下角你会看到这个问题的一些选项。确保对于 Method 选项卡,Scope 设置为 public。还要检查 Ignore simple 属性 access 因为你不想被告知缺少文档的 getter 和 setter。

点击确定保存。

2。检查代码

在 IntelliJ 的顶部菜单栏中打开 Analyze -> Inspect Code...、select 应检查多少以及 运行 它由单击 确定。在 检查结果 中查找 Java 文件问题 -> 声明有 Java 文件问题 。那些说明 Required Javadoc is absent 的问题正是您要找的。