XMLコマンド

Doxygenは、C#コードコメントで一般的に使用されるXMLコマンドのほとんどをサポートしています。XMLタグは、C#言語を定義するECMA-334標準の付録Dで定義されています。残念ながら、この仕様はあまり正確ではなく、提供されている例のいくつかは品質が低いものです。

以下はDoxygenがサポートするタグのリストです

XMLコマンド	説明
<c>	コードの一部としてレンダリングされるべきインラインテキストを識別します。<tt>text</tt>の使用に似ています。
<code>	1行以上のソースコードまたはプログラム出力を設定します。このコマンドは、C#コードでは\code ... \endcodeのように動作しますが、他の言語ではHTMLの同等の<CODE>...</CODE>のように動作することに注意してください。
<description>	<list>コマンドの一部で、項目を記述します。
<example>	テキストブロックを例としてマークしますが、Doxygenでは無視されます。
<exception cref="member">	メソッドがスローする可能性のある例外を識別します。
<include>	外部ファイルからXMLの一部をインポートするために使用できます。現在のところDoxygenでは無視されます。
<inheritdoc>	基底クラスのメンバーのドキュメントを、それを再実装する派生クラスのメンバーのドキュメントに挿入するために使用できます。
<item>	リスト項目。<list>コンテキスト内でのみ使用できます。
<list type="type">	リストを開始します。サポートされるタイプは、bullet、number、およびtableです。リストは複数の<item>タグで構成されます。テーブルタイプのリストは、ヘッダーを持つ2列のテーブルです。
<listheader>	タイプ「table」のリストのヘッダーを開始します。
<para>	テキストの段落を識別します。
<param name="paramName">	テキストの一部をパラメータ「paramName」のドキュメントとしてマークします。\paramの使用に似ています。
<paramref name="paramName">	パラメータ「paramName」を参照します。\aの使用に似ています。
<permission>	メンバーのセキュリティアクセス可能性を識別します。Doxygenでは無視されます。
<remarks>	詳細な説明を識別します。
<returns>	テキストの一部を関数またはメソッドの戻り値としてマークします。\returnの使用に似ています。
<see cref="member">	メンバーを参照します。\refに似ています。
<seealso cref="member">	「member」を参照する「関連項目」セクションを開始します。\sa memberの使用に似ています。
<summary>	このタグが<DETAILS>タグの外で使用される場合、このタグは短い説明を識別します。\briefの使用に似ています。このタグが<DETAILS>タグ内で使用される場合、このタグは<DETAILS>タグの見出しを識別します。
<term>	<list>コマンドの一部です。
<typeparam name="paramName">	テキストの一部を型パラメータ「paramName」のドキュメントとしてマークします。\paramの使用に似ています。
<typeparamref name="paramName">	パラメータ「paramName」を参照します。\aの使用に似ています。
<value>	プロパティを識別します。Doxygenでは無視されます。
<![CDATA[...]]>	このタグ（...の部分）内のテキストは、XMLの特殊文字である<、>、&がエスケープされたかのように使用される点を除いて、通常のDoxygenコメントとして扱われます。

以下に、上記のコマンドの一部を使用した典型的なコードの例を示します。

/// <summary>
/// A search engine.
/// </summary>
class Engine
{
/// <summary>
/// The Search method takes a series of parameters to specify the search criterion
/// and returns a dataset containing the result set.
/// </summary>
/// <param name="connectionString">the connection string to connect to the
/// database holding the content to search</param>
/// <param name="maxRows">The maximum number of rows to
/// return in the result set</param>
/// <param name="searchString">The text that we are searching for</param>
/// <returns>A DataSet instance containing the matching rows. It contains a maximum
/// number of rows specified by the maxRows parameter</returns>
  public DataSet Search(string connectionString, int maxRows, int searchString)
  {
DataSet ds = new DataSet();
    return ds;
  }
}

次のセクションへ進むか、インデックスに戻る。