XMLコマンド

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

以下は、Doxygenでサポートされているタグのリストです。

XMLコマンド	説明
<c>	インラインテキストを、コードの一部としてレンダリングする必要があることを識別します。<tt>テキスト</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> タグで構成されます。tableタイプのリストは、ヘッダーを持つことができる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>
/// 検索エンジン。
/// </summary>
class Engine
{
/// <summary>
/// Searchメソッドは、検索条件を指定するための一連のパラメータを受け取り
/// 結果セットを含むデータセットを返します。
/// </summary>
/// <param name="connectionString">検索するコンテンツを保持するデータベースへの接続文字列</param>
/// データベース接続文字列
/// <param name="maxRows">結果セットで返す最大行数</param>
/// 結果セットで返す最大行数
/// <param name="searchString">検索対象のテキスト</param>
/// <returns>一致する行を含むDataSetインスタンス。maxRowsパラメータで指定された最大行数を含みます</returns>
/// 一致する行を含むDataSetインスタンス。maxRowsパラメータで指定された最大行数を含みます
  public DataSet Search(string connectionString, int maxRows, int searchString)
  {
DataSet ds = new DataSet();
    return ds;
  }
}

次のセクションに進むか、インデックスに戻ります。