1. ホーム
  2. java

[解決済み] 汎用型パラメータを文書化するためのjavadocタグはありますか?

2022-04-20 04:25:45

質問

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

例えば @typeparam と同じように、通常の @param しかし、メソッドだけでなく、型にも適用できます。

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

このようなタグは存在しないのでしょう。どこにもそのような記述はありませんし、JavaSE APIドキュメントにもそのような記述はありません。しかし、それは奇妙な欠落のように思える。誰かが私を正すことができますか?

どのように解決するのですか?

このようにすればいいのです。

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

}

ソース