提问人：jsrc..programmer 提问时间：8/1/2023 最后编辑：Mark Rotteveeljsrc..programmer 更新时间：8/1/2023 访问量：52
Java 或 IntelliJ 2022.2 中是否有办法通过注释抑制 MissingJavadoc 警告？
Is there a way in Java or IntelliJ 2022.2 to suppress MissingJavadoc warnings with an annotation?
问：
我知道可以通过创建自定义注释来有目的地抑制 Java/IntelliJ 2022.2 中未使用的方法警告，然后使用上下文菜单来抑制未使用的警告（如果使用自定义注释进行注释）。但是，我也想用其他警告来做到这一点，尤其是 MissingJavadoc 警告。我有一些大型枚举，我故意在其中非常明确地说明它们的名称，因此为每个元素创建单独的 Javadoc 注释将是费力和冗余的。但是，如果可以的话，我宁愿不要只使用 @SuppressWarnings（“MissingJavadoc”），因为这会失去使元素名称显式的意图，并且看起来像草率的编码。
有谁知道除了未使用的警告之外，是否有可能像这样有意地进行压制？或者，这就是我们所拥有的吗？
答：
0赞
mernst
8/1/2023
#1
该工具本身在需要 Javadoc 注释的位置方面不是很可配置。对于您的用例，最好禁用 的警告，而是使用其他工具来强制该文档存在。require-javadoc 就是这样一种工具。您可以使用其命令行参数，也可以使用新的命令行参数创建程序版本，该参数可以理解您的命名约定。javadocjavadoc--dont-require=<regex>
评论
0赞
jsrc..programmer
8/2/2023
谢谢;我认为您可能是对的，在我的 IDE 中禁用 Javadoc 警告并使用其他工具仅在我想要的地方强制执行它是正确的方法。直到你说出来，我才想到;谢谢你的想法。
评论