NDoc でサポートするタグ

<event>

メンバによって発生るイベントを記述します。

構文:
///<event cref="EventName">
///    〜イベントを発生させます。
///</event>

<example>

メンバの使用例を記述します。詳細はマイクロソフトの 定義 を参照してください。

使用例の <code> ブロックを複数記述する場合は、 インデントの問題を回避する為にインクルードファイルとして配置しリンクさせてください。

<exception>

メンバによって発生る可能性のある例外を記述します。詳細はマイクロソフトの 定義 を参照してください。

<include>

参照させたいインクルードファイルとその参照先を記述します。詳細はマイクロソフトの 定義 を参照してください。

<overloads>

この新しいタグにはオーバーロード全てに共通するドキュメントを記述します。 このタグは最初のオーバーロードに記述するだけで、残りのオーバーロード全てに適用されます。

<overloads> タグは２つの書式で記述することができます:

• 概要として扱われるテキストブロックだけの書式。
• 長いフォームでは、複数の適切なセクション タグ（<summary>タグ、<remarks>タグ、<example>タグ）を含む書式。

使用例:
///<overloads>このメソッドには２つのオーバーロードがあります。</overloads>
///<summary>このオーバーロードはただ Hello と言います。</summary>
public void SayHello() { ... }
///<summary>このオーバーロードは Hello と toSomeone に言います。</summary>
public void SayHello(string toSomeone) { ... }

<param>

メンバのパラメータを記述します。詳細はマイクロソフトの 定義 を参照してください。

<permission>

メンバへのアクセスを記述します。詳細はマイクロソフトの 定義 を参照してください。

<remarks>

解説を記述します。詳細はマイクロソフトの 定義 を参照してください。

<returns>

メンバの戻り値を記述します。詳細はマイクロソフトの 定義 を参照してください。

<seealso>

ドキュメントの参照部分にリンクを追加します。詳細はマイクロソフトの 定義 を参照してください。

<remarks> にこのタグを含まないでください。

構文:

• <seealso href="url">[label]</seealso>
• <seealso cref="member">[label]</seealso>

<summary>

概要を記述します。詳細はマイクロソフトの 定義 を参照してください。

<value>

プロパティ値についての説明を記述します。詳細はマイクロソフトの 定義 を参照してください。

<code>

ソースコードを記述するブロックです。詳細はマイクロソフトの 定義 を参照してください。

<code> ブロックを複数記述する場合は、 インデントの問題を回避する為にインクルードファイルとして配置しリンクさせてください。

<list>

表または定義リストの見出し行を記述するブロックです。 詳細はマイクロソフトの 定義 を参照してください。

<para>

１つの段落を表すブロックです。詳細はマイクロソフトの 定義 を参照してください。

<c>

１行で収まるソースコードを記述する際に使用します。詳細はマイクロソフトの 定義 を参照してください。

<paramref>

パラメータへの参照を記述する際に使用します。詳細はマイクロソフトの 定義 を参照してください。

<see>

他のメンバ又は型への参照を記述する際に使用します。詳細はマイクロソフトの 定義 を参照してください。

構文:

• <see href="url">[label]</see>
• <see cref="member">[label]</see>