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

<summary>description</summary>

パラメータ

• description
  オブジェクトの要約。

解説

<summary> タグは、型または型のメンバの説明に使用します。型の説明に補足情報を追加するには、<remarks> タグを使用します。

<summary> タグのテキストは、IntelliSense で、型に関する唯一の情報源になり、オブジェクト ブラウザ にも表示されます。

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

使用例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

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

参照

関連項目

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

概念

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