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>
/// 検索エンジン。
/// </summary>
class Engine
{
/// <summary>
/// Searchメソッドは、検索条件を指定するための一連のパラメータを受け取り、
/// 結果セットを含むデータセットを返します。
/// </summary>
/// <param name="connectionString">検索するコンテンツを保持する
/// データベースに接続するための接続文字列</param>
/// <param name="maxRows">結果セットで返す最大行数</param>
/// </param>
/// <param name="searchString">検索対象のテキスト</param>
/// <returns>一致する行を含むDataSetインスタンス。maxRowsパラメータで指定された
/// 最大行数を含みます</returns>
  public DataSet Search(string connectionString, int maxRows, int searchString)
  {
DataSet ds = new DataSet();
    return ds;
  }
}

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