我一直在浏览Sun网站上的javadoc文档,试图找到是否有一个javadoc标记可用于记录类或方法的通用类型签名。
类似于@typeparam
,类似于通常@param
,但适用于类型和方法,例如
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
我怀疑没有这样的标记-我在任何地方都找不到它的标记,并且JavaSE API文档没有显示任何标记,但这似乎是一个奇怪的遗漏。有人可以说对吗?
7
要编写适当的javadocs?
—
Timo Willemsen 2010年
请注意,对于大多数类而言,关于类型参数的确没有什么要说的,因为类型参数本质上是由其在对象方法中的显示方式定义的。我
—
Kevin Bourrillion 2010年
@param <T>
大部分时间会跳过,只在不清楚的时候才使用它。
我明白您在说什么,但是根据这个基本原理,
—
skaffman 2010年
@param
对于for方法参数的使用也是如此。Sun的编码标准明确指出,@param
即使方法参数的含义很明确,也应使用该代码。
在此之上。好的API编程应尽可能地自我记录。这是否意味着api不需要文档?没有。
—
Timo Willemsen 2010年