Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/java/361.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
是否有用于记录泛型类型参数的javadoc标记?_Java_Javadoc - Fatal编程技术网

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

是否有用于记录泛型类型参数的javadoc标记?,java,javadoc,Java,Javadoc,我一直在查看Sun网站上的javadoc文档,试图找到是否有一个javadoc标记可用于记录类或方法的泛型类型签名 类似于@typeparam,类似于通常的@param,但适用于类型和方法,例如 /** * @typeparam T This describes my type parameter */ class MyClass<T> { } /** *@typeparam T这描述了我的类型参数 */ 类MyClass{ } 我怀疑没有这样的标签——我在任何地方都找不到

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

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

/**
 *  @typeparam T This describes my type parameter
 */
class MyClass<T> {
}
/**
*@typeparam T这描述了我的类型参数
*/
类MyClass{
}

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

应该这样做:

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

}
/**
*@param这描述了我的类型参数
*/
类MyClass{
}
是的。 只需使用@param标记,并在类型参数周围包含尖括号

像这样:

/**
 *  @param <T> This describes my type parameter
 */
/**
*@param这描述了我的类型参数
*/

编写正确的javadocs?请注意,对于大多数类来说,类型参数真的没有什么有趣的地方,因为类型参数本质上是由它在对象方法中的显示方式定义的。大多数时候我都会跳过
@param
,只在不清楚的时候才使用它。我明白你的意思,但根据这个原理,使用
@param
作为方法参数也是一样的。Sun的编码标准明确规定,即使方法参数的含义明确,也应使用
@param
。此外。好的API编程应该尽可能自我记录。这是否意味着api不需要文档?否。提供了有关类型参数的说明。请注意,Oracle可以更好地宣传此文档。Doh。。。。好吧,这很明显。。。它提出了一个问题,为什么JavaScript类(例如,代码>集合< /代码>)不使用它,考虑到。Link列表使用它:“Skffman当然晚了一点,但是它提出了问题,但它没有。”Sou84No从您的链接中说:一些权威认为使用“回避问题”作为“提出问题”或“回避问题”的方式。不再是错误的,因为它已经得到了如此广泛的使用。很遗憾IntelliJ在这种情况下像HTML一样完成。