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

时间:2015-12-07 11:23:45

标签: intellij-idea javadoc intellij-15

使用IntelliJ IDEA 15,如何找到缺少javadoc的公共方法,从而导致SonarQube指标公共文档化API的显示减少here

1 个答案:

答案 0 :(得分:5)

IntelliJ能够检查代码

1。调整检查设置

为了识别缺少的公共文档,首先启用问题声明有Javadoc问题。您可以通过打开IDE Settings并选择 Editor - >来完成此操作。检查。在右侧菜单中选择 Java - > Javadoc问题 - >声明有Javadoc问题。激活此问题。

enter image description here

再次在右下角,您会看到此问题的一些选项。确保对于选项卡方法范围设置为 public 。还要检查忽略简单属性访问,因为您不希望被告知缺少文档的getter和setter。

enter image description here

点击确定进行保存。

2。检查代码

在IntelliJ的顶部菜单栏中打开 Analyze - >检查代码... ,通过单击确定选择要检查的数量并运行它。在检查结果中查找 Javadoc问题 - >声明有Javadoc问题。那些陈述必需的Javadoc的问题是您正在寻找的。