コンテンツにスキップ

[型名] - API仕様書

名前空間: [名前空間] アセンブリ: [アセンブリ名] 継承: [基底クラス] -> [インターフェース1], [インターフェース2] ジェネリックパラメータ:

  • T: [制約 (例: struct)] - [パラメータの説明]

概要

[この型の目的と主要な役割についての簡潔な説明を記述します。] [どのような問題を解決するのか、どのような場面で使用されるのかを明確にします。]

コンストラクタ

コンストラクタ名

[このコンストラクタの役割を説明します。]

  • パラメータ:
    • [パラメータ名]: ([型]) - [パラメータの説明]
    • [パラメータ名]: ([型]) - [パラメータの説明]
  • スローする例外:
    • [例外の種類]: [例外がスローされる条件]
    • [例外の種類]: [例外がスローされる条件]

プロパティ

[プロパティ名]

型: [プロパティの型] アクセス: { get; [set/init;] }

[このプロパティの役割と、取得/設定される値の意味を説明します。]

  • 値:
    • [プロパティが返す値についての詳細な説明。]
  • スローする例外:
    • [例外の種類]: [get/set時に例外がスローされる条件]

(プロパティごとにこのセクションを繰り返す)

メソッド

メソッド名

[このメソッドの目的と、何を行うかを説明します。]

  • パラメータ:
    • [パラメータ名]: ([型]) - [パラメータの説明]
  • 戻り値:
    • ([戻り値の型]) - [戻り値の説明。戻り値が void や Task の場合はこのセクションは不要。]
  • スローする例外:
    • [例外の種類]: [例外がスローされる条件]
  • 備考:
    • [メソッドの挙動に関する補足事項、注意点、関連情報などを記述します。]

  • コード例:

    // このメソッドの典型的な使用例を示すコード

(メソッドごとにこのセクションを繰り返す)

イベント

[イベント名]

イベントハンドラの型: [デリゲート型] (例: EventHandler<EventArgs>)

[このイベントが発生する条件と、その目的を説明します。]

  • イベント引数:
    • [EventArgs派生クラス名]: [イベントと共に渡されるデータの詳細説明。]

Enumメンバー

メンバー名 値 (任意) 説明
[メンバー1] 0 [メンバー1の説明]
[メンバー2] 1 [メンバー2の説明]

関連事項