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

2022-09-01 10:46:14

Eclipse 能够在 Javadoc 未针对特定方法或字段实现时提供警告。这些字段/方法可以按范围(公共、受保护等)分组。我发现这在准备我的软件以提交大学或其他任何东西时确实非常有用。

这在IntelliJ中是不可能的吗?

请注意,我知道您可以在IntelliJ中的方法之前点击“/**”,它将填充它。这并不是我所追求的。

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


答案 1

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

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

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

enter image description here

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

enter image description here


答案 2

推荐