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

<paramref name="name"/>

パラメータ

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

解説

<paramref> タグを使用すると、<summary> ブロックや <remarks> ブロックなどのコード コメント内の単語をパラメータの参照として指定できます。XML ファイルは、この単語に太字や斜体などの異なる書式を設定するように処理できます。

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

使用例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.  
    /// The <paramref name="Int1"/> parameter takes a number.
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

参照

関連項目

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

概念

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