如何让IntelliJ在我未为公共字段和方法提供JavaDoc描述/注释时发出警告?

31

Eclipse可以在特定方法或字段的Javadoc未满足时提供警告。 这些字段/方法可以按作用域(public,protected等)分组。当我准备将软件提交给大学或其他机构时,我发现这非常有用。

IntelliJ不能做到这一点吗?

请注意,我知道在IntelliJ中可以在方法之前键入“/**”,它会自动填充。但这并不是我想要的。

还请注意,我正在使用IntelliJ 13.01 Community Edition。


听起来像是 CheckStyle 的工作。 - Bohemian
1个回答

43

对于旧版本的IntelliJ: 首选项 > 检查 > JavaDoc问题 > 声明有JavaDoc问题

对于新版本的IntelliJ: 文件 > 设置... > 编辑器 > 检查 > Java > JavaDoc问题 > 声明有JavaDoc问题

确保将"范围"滑块移动到所需的包、类、方法、字段和内部类的可见性级别, 默认设置为 "无"。您也可以设置 "严重程度" 级别。

enter image description here

除了持续监控外,您还可以使用 Cmd-Option-Shift-I 在需要时调用检查,并在 VCS 提交之前执行检查(尽管这不会阻止您使用命令行提交代码)。您还可以创建特定的检查配置文件,例如一个用于大学提交,另一个用于您的副业项目。

enter image description here


2
+1 for: "确保将“范围”滑块移动到所需的包、类、方法、字段和内部类的可见级别",这正是我所缺少的。 - Pith

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接