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

ska*_*man 163 java javadoc

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

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

/**
 *  @typeparam T This describes my type parameter
 */
class MyClass<T> {
}
Run Code Online (Sandbox Code Playgroud)

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

Tim*_*sen 230

应该这样做:

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

}
Run Code Online (Sandbox Code Playgroud)

资源

  • @skaffman当然有点晚了,但它提出了*问题,它没有[求问](http://en.wikipedia.org/wiki/Begging_the_question). (9认同)
  • 在这种情况下,IntelliJ完全像HTML一样令人遗憾. (8认同)
  • LinkedList使用它:http://java.sun.com/j2se/1.5.0/docs/api/java/util/LinkedList.html (6认同)
  • @ Thor84no从你的链接:有些当局认为使用"乞求问题"作为一种说"提出问题"或"回避问题"的方式不再是错误的,因为它已经获得如此广泛的使用. (6认同)
  • Doh ....好吧,这是令人尴尬的显而易见......但它确实提出了为什么JavaSE类(例如`Collection`)不使用它的问题. (5认同)

小智 27

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

像这样:

/**
 *  @param <T> This describes my type parameter
 */
Run Code Online (Sandbox Code Playgroud)