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

<param name="name">description</param>

パラメーター

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

• description
  パラメーターの説明。

解説

<param> タグは、メソッド宣言のコメント内で使用してメソッドのパラメーターの 1 つを説明します。複数のパラメーターを文書化するには、複数の <param> タグを使用します。

<param> タグのテキストは、IntelliSense、オブジェクト ブラウザー、およびコード コメント Web レポートに表示されます。

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

使用例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    // Single parameter.
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }

    // Multiple parameters.
    /// <param name="Int1">Used to indicate status.</param>
    /// <param name="Float1">Used to specify context.</param>
    public static void DoWork(int Int1, float Float1)
    {
    }

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

参照

関連項目

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

概念

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