通用类型<P>在Javadoc中转换为段落标记

Question

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

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

这在实际的Javadoc中显示得很好.但是,CheckStyle警告我需要记录类型P,因为它将<P>呈现为HTML段落.此外,Eclipse格式化程序也将其解释为段落,因此它会混淆格式.

是否有更好的方法来记录类型为P的类型参数？我知道我可以禁用Eclipse格式化程序,不再自动格式化javadoc,但我宁愿不这样做(并且无论如何都不会解决checkstyle问题).

我也知道我可以将P重命名为其他东西,但考虑到我在这里使用的泛型类型的数量,它会使事情的可读性降低很多.

Answer 1

这是CheckStyle中的一个错误.

该负责人Javadoc文档说,符号是正确的:

类的类型参数示例:

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

如果您坚持使用此版本的CheckStyle,那么满足这两个约束的唯一方法是将您的P类型参数重命名为其他参数.

Answer 2

对于后代：事实证明 Checkstyle 处理得很好。问题是 Eclipse 格式化程序添加的空格使 Checkstyle（合理地）认为 Javadoc 不正确。我还在 Eclipse 中找到了此错误的现有错误报告：https://bugs.eclipse.org/bugs/show_bug.cgi ?id=121728