<typeparam> (C# プログラミング ガイド)

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

パラメーター

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

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

解説

ジェネリック型またはジェネリック メソッドを宣言して型パラメーターを説明する場合、コメントに <typeparam> タグを使用します。 ジェネリック型またはジェネリック メソッドの型パラメーターごとに、タグを追加します。

詳細については、「ジェネリック (C# プログラミング ガイド)」を参照してください。

<typeparam> タグのテキストは、Object Browser Window コード コメント Web レポートである、IntelliSense に表示されます。

コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。

使用例

// compile with: /doc:DocFileName.xml  

/// comment for class 
public class TestClass
{
    /// <summary> 
    /// Creates a new array of arbitrary type <typeparamref name="T"/>
    /// </summary> 
    /// <typeparam name="T">The element type of the array</typeparam>
    public static T[] mkArray<T>(int n)
    {
        return new T[n];
    }
}

参照

関連項目

ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)

概念

C# プログラミング ガイド

その他の技術情報

C# リファレンス