带有泛型的未知 Javadoc 标记类型答案

【问题标题】：Unknown Javadoc tag TYPE with generics带有泛型的未知 Javadoc 标记类型
【发布时间】：2021-09-25 02:54:46
【问题描述】：

我有 javadoc 的方法：

/**
 * Supplier interface mixed with {@link ServiceCast}.
 * @param <R> is <TYPE> of supplier.
 */
public interface ServiceCastSupplier<R> extends ServiceCast, Supplier<R> {

}

在管道中我收到错误：

error: unknown tag: TYPE
[ERROR]      * @param <R> is <TYPE> of supplier

为什么不喜欢<R>，有什么问题？

【问题讨论】：

它不喜欢的是<TYPE>。它不是类型变量之一。
如果您需要用尖括号显示，请尝试使用@literal。

标签： java generics javadoc

【解决方案1】：

理想的解决方案是将文档更改为

/**
 * Supplier interface mixed with {@link ServiceCast}.
 * @param <R> is the type of supplier.
 */

即像标准库一样完全删除<TYPE>，除非它对您的代码有重要意义。

如果确实需要显示尖括号，可以使用{@literal}

/**
 * Supplier interface mixed with {@link ServiceCast}.
 * @param <R> is {@literal <TYPE>} of supplier.
 */

【讨论】：