代码之家 › 专栏 › 技术社区 › skaffman

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

javadoc java

149

skaffman · 技术社区 · 16 年前

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

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

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

我怀疑没有这样的标签——我在任何地方都找不到关于它的任何提及,JavaseAPI文档也没有显示任何迹象,但它似乎是一个奇怪的遗漏。有人能纠正我吗?

2 回复 | 直到 8 年前

211

Timo Willemsen 16 年前

应该这样做:

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

}

Boro 13 年前

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

这样地:

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

推荐文章

Stephen.lin · 当鼠标向上移动弹出java文档时,IntelliJ思想如何像eclipse一样工作

8 年前

Vulkanos · 我可以在自定义doclet的帮助下生成Javadoc注释吗?

8 年前

Fraquack · Kotlin-接口方法引发的文档异常

8 年前

Adrien Aacha · Javadocs-@param name未找到

8 年前

Mohan · 为具有(模拟的)可选/默认参数的函数编写Javadoc

8 年前

Jai · vararg方法的Javadoc链接

8 年前

grandouassou · 使用Java Bean验证注释从POJO生成文档

8 年前

drJava · 在JavaDoc中将方法参数与类成员链接

9 年前

Batman · Javadoc和继承的类

10 年前

CrypticStorm · IntelliJ Javadoc每行增加一个星号

11 年前