如何在没有 -Xdoclint 警告的情况下使用 JavaDoc 记录？

Question

我一直在努力让自己熟悉记录，但我运行发现了一些看起来确实像 Java 的 linting JavaDoc -Xdoclint 工具中的错误。

我尝试使用这个命令...

 javac     -Xdoclint:all       XdoclintDoesntHandleRecordJavadocCorrectly.java

...整理我的 Java此文件的文档...

/**
 *
 * Comment.
 *
 * @param a Comment.
 * @param b Comment.
 * @param c Comment.
 *
 */
public record XdoclintDoesntHandleRecordJavadocCorrectly(
/** Comment. */
int a,
/** b Comment. */
int b,
/** @param c Comment. */
int c
) {}

...这给了我这个错误...

XdoclintDoesntHandleRecordJavadocCorrectly.java:14: warning: no comment
int a,
    ^
XdoclintDoesntHandleRecordJavadocCorrectly.java:16: warning: no comment
int b,
    ^
XdoclintDoesntHandleRecordJavadocCorrectly.java:18: warning: no comment
int c
    ^
3 warnings

...这对我来说毫无意义。

这是 Java 的 -Xdoclint 工具中的错误吗？通常情况下，我不会那么快提出索赔，但是 .

最后，这是我的 java 版本。

$ java --version
java 18 2022-03-22
Java(TM) SE Runtime Environment (build 18+36-2087)
Java HotSpot(TM) 64-Bit Server VM (build 18+36-2087, mixed mode, sharing)

Answer 1

由于Javadoc example for records in the OpenJDK repository给出了相同的警告，这肯定是一个错误。

编辑：Java Language Specification 提供了线索：

For each record component, a record class has a field with the same name as the record component and the same type as the declared type of the record component. This field, which is declared implicitly, is known as a component field.

所以“无评论”很可能指的是记录 class 的这个 隐式声明的组件字段 记录不能评论，类似.

如何在没有 -Xdoclint 警告的情况下使用 JavaDoc 记录？

How to JavaDoc a record without warnings from -Xdoclint?

java

warnings

javadoc

false-positive