web-dev-qa-db-ja.com

ジェネリック型パラメーターを文書化するためのjavadocタグはありますか?

Sunのサイトでjavadocのドキュメントを調べて、クラスまたはメソッドのジェネリック型シグネチャをドキュメント化するために使用できるjavadocタグがあるかどうかを調べました。

何かのようなもの @typeparam、通常の@param、ただしメソッドだけでなくタイプにも適用可能。

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

そのようなタグはないのではないかと疑っています。どこにも言及していませんし、JavaSE APIドキュメントにはその兆候はありませんが、奇妙な省略のようです。誰かが私を正すことができますか?

158
skaffman

次のように行う必要があります。

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

}

ソース

224
Timo Willemsen

はい。 @paramタグを使用し、typeパラメータの周りに山括弧を含めるだけです。

このような:

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