如果我未能为公共字段和方法提供JavaDoc描述/注释,如何让IntelliJ给我一个警告?

时间:2014-01-09 01:09:09

标签: java eclipse intellij-idea javadoc

如果Javadoc未针对特定方法或字段执行,则Eclipse能够提供警告。 这些字段/方法可以按范围(公共,受保护等)进行分组。 在准备我的软件提交大学或其他什么时,我发现这非常有用。

这在IntelliJ中是不可能的吗?

请注意,我知道您可以在IntelliJ中的某个方法之前点击“/ **”,它会将其填满。这不完全是我追求的。

另请注意,我正在使用IntelliJ 13.01社区版。

1 个答案:

答案 0 :(得分:37)

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

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

确保将“范围”滑块移动到包,类,方法,字段和内部类的所需可见级别,默认情况下将其设置为“无”。您还可以设置“严重性”级别。

enter image description here

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

enter image description here

相关问题