是否有用于记录泛型类型参数的javadoc标记?

时间:2010-01-06 20:27:34

标签: java javadoc

我一直在浏览Sun网站上的javadoc文档,试图查找是否有一个javadoc标记可用于记录类或方法的泛型类型签名。

@typeparam这样的东西,类似于通常的@param,但适用于类型和方法,例如

/**
 *  @typeparam T This describes my type parameter
 */
class MyClass<T> {
}

我怀疑没有这样的标签 - 我在任何地方都找不到它,并且JavaSE API文档没有显示任何迹象,但它似乎是一个奇怪的遗漏。有人能把我弄好吗?

2 个答案:

答案 0 :(得分:218)

应该这样做:

/**
 * @param <T> This describes my type parameter
 */
class MyClass<T>{

}

Source

答案 1 :(得分:26)

是。 只需使用@param标记,并在类型参数周围包含尖括号。

像这样:

/**
 *  @param <T> This describes my type parameter
 */