java - 带有泛型的未知 Javadoc 标记类型

Question

我有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>，有什么问题？

标签： javagenericsjavadoc

Answer 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.
 */