Intellij Idea 在Java或IntelliJ 2022.2中是否有一种方法可以通过注解来抑制MissingJavadoc警告?

e5nqia27  于 2023-08-03  发布在  Java
关注(0)|答案(1)|浏览(136)

我知道在Java/IntelliJ 2022.2中可以有目的地抑制未使用的方法警告,方法是创建一个自定义注解,然后使用上下文菜单来抑制未使用的警告(如果使用自定义注解进行注解)。但是,我也想对其他警告这样做,特别是MissingJavadoc警告。我有一些大型枚举,我故意非常明确地给出了它们的名称,因此为每个元素创建单独的Javadoc注解将是费力和多余的。但是,如果可以的话,我宁愿不使用@SuppressWarnings(“MissingJavadoc”),因为这失去了使元素名称显式化的意图,看起来像是草率的编码。
有谁知道除了未使用的警告之外,是否可以像这样对任何东西进行有意的抑制?或者,这就是我们所有的吗?

2wnc66cl

2wnc66cl1#

javadoc工具本身在需要Javadoc注解的地方不是很可配置。对于您的用例,您最好禁用javadoc的警告,并使用不同的工具来强制执行文档的存在。一个这样的工具是require-javadoc。您可以使用它的--dont-require=<regex>命令行参数,或者您可以创建一个具有新的命令行参数的程序版本,该参数可以理解您的命名约定。

相关问题