<typeparam> (Visual Basic)

更新 : 2007 年 11 月

型パラメータの名前と説明を定義します。

<typeparam name="name">description</typeparam>

パラメータ

  • name
    型パラメータの名前です。名前は、二重引用符 (" ") で囲みます。

  • description
    型パラメータの説明です。

解説

ジェネリック型またはジェネリック メンバ宣言のコメント内で <typeparam> タグを使用すると、型パラメータの 1 つについての説明を記述できます。

コンパイル時に /doc を指定すると、ドキュメント コメントをファイルに出力できます。

使用例

<typeparam> タグを使って id パラメータの説明を記述する例を次に示します。

''' <typeparam name="T">
''' The base item type. Must implement IComparable.
''' </typeparam>
Public Class itemManager(Of T As IComparable)
    ' Insert code that defines class members.
End Class

参照

参照

ドキュメント コメントとして推奨される XML タグ (Visual Basic)