java - 泛型类型 在 Javadoc 中转换为段落标记

Question

我有一个泛型类型为 P 的 Java 类。我想在 Javadoc 中记录它。通常我只是这样做:

/**
 * ...
 * @param <P> the type of publisher
 */

这在实际的 Javadoc 中显示得很好。但是，CheckStyle 警告我需要记录类型 P，因为它将

呈现为 HTML 段落。此外，Eclipse 格式化程序也将其解释为一个段落，因此它会弄乱格式。

有没有更好的方法来记录类型 P 的类型参数？我知道我可以禁用 Eclipse 格式化程序以不再自动格式化 javadoc，但我宁愿不这样做(而且它无论如何也无法解决 checkstyle 问题)。

我也知道我可以将 P 重命名为其他名称，但考虑到我在这里使用的泛型类型的数量，这会使事情的可读性大大降低。

Answer 1

这是 CheckStyle 中的一个错误。

official Javadoc documentation表示符号是正确的:

Example of a type parameter of a class:

 /**
  * @param <E> Type of element stored in a list
  */

如果您被这个版本的 CheckStyle 卡住，那么满足这两个约束的唯一方法是将您的 P 类型参数重命名为其他名称。