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

Posted 2023-02-26

【中文标题】如果我未能为公共字段和方法提供 JavaDoc 描述/注释，如何让 IntelliJ 给我一个警告？

【英文标题】：How do I get IntelliJ to give me a warning if I have failed to provide JavaDoc description/annotation for public fields and methods?

【发布时间】：2014-01-27 09:25:45

【问题描述】：

如果 Javadoc 未满足特定方法或字段的要求，Eclipse 能够提供警告。 这些字段/方法可以按范围（公共、受保护等）分组。 在准备我的软件以提交给大学或其他什么时，我发现这确实非常有用。

这在 IntelliJ 中是不可能的吗？

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

另请注意，我使用的是 IntelliJ 13.01 社区版。

【问题讨论】：

听起来像是 CheckStyle 的工作

【参考方案1】：

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

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

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

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

【讨论】：

+1 for : Make sure to move "scope" slider to desired level of visibility for packages, classes, methods, fields and inner classes 这正是我所缺少的