<event>【発生イベント】
<overloads>【オーバーロード】
<threadsafety>【スレッドセーフ】

メモ

<event>【発生イベント】

  • 発生イベントの説明
    • 発生イベント数分記述

<overloads>【オーバーロード】

  • オーバーロードの説明
    • オーバーロードの1つにのみ記述
    • オーバーロード用ページに全体の説明として出力

<threadsafety>【スレッドセーフ】

  • クラス・構造体のメンバのスレッドセーフ

構文

<event cref="【イベントタイプ名】">【イベントの説明】</event>

<overloads>【オーバーロードの説明】</overloads>

<overloads>
  <summary>
  【オーバーロードの説明】
  </summary>
  [<remarks>【オーバーロードの備考】</remarks>]
  [<example>【オーバーロードの例】</example>]
  [【その他オーバーロードのコメント】]
</overloads>

<threadsafety static="true | false【静的メンバの安全性】" instance="true | false【インスタンスメンバの安全性】" />

関連

/// <summary>クラスの概要</summary>
/// <threadsafety static="true" instance="false"/>
public class ClassTest
{
    /// <summary>メソッドの概要 (スレッドセーフ)</summary>
    public static void MethodSafety()
    {
        // スレッドセーフなコード
    }

    /// <summary>メソッドの概要</summary>
    /// <overloads>オーバーロードの説明</overloads>
    public void MethodOverloadA() { }

    /// <summary>メソッドの概要</summary>
    /// <param name="p1">パラメータの説明</param>
    /// <event cref="EventA">イベントAの説明</event>
    /// <event cref="EventB">イベントBの説明</event>
    public void MethodOverloadA(int p1)
    {
        this.EventA();
        this.EventB();
    }

    /// <summary>イベントの説明</summary>
    public void EventA() { }

    /// <summary>イベントの説明</summary>
    public void EventB() { }

    /// <summary>メソッドの概要</summary>
    /// <overloads>
    ///   <summary>オーバーロードの説明</summary>
    ///   <remarks>オーバーロードの備考</remarks>
    /// </overloads>
    public void MethodOverloadB() { }

    /// <summary>メソッドの概要</summary>
    /// <param name="p1">パラメータの説明</param>
    public void MethodOverloadB(int p1) { }
}