XMLコマンド

Doxygenは、特に C# のコードコメントによく使われるXMLコマンドの多くをサポートしています。XMLタグは、C# 言語を定義する、ECMA-334規格の付録Eで定義されています。しかし、その仕様は、それほど正確でなく、示されている例の品質も低いです。

doxygenがサポートするタグを以下にリストアップします。

<c> コードとして表示すべきインラインテキストを識別します。<tt>text</tt>を使うのと同様です。
<code> 一行以上のソースコードあるいはプロブラム出力をセットします。C# コードでは \code ... \endcode のように振る舞いますが、他の言語では HTMLで同等の <code>...</code> のように振る舞います。
<description> <list> コマンドの一部で、アイテムを記述します。
<example> テキストブロックを例としてマークします。doxygenは無視します。
<exception cref="member"> メソッドが投げられる例外を識別します。
<include> XMLコードを外部ファイルからインポートします。現状、doxygenは無視します。
<inheritdoc> ある基底クラスのメンバードキュメントを、それを再実装した派生クラスのメンバードキュメントに挿入するのに使えます。
<item> 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"を参照する"See also"セクションを開始します。\sa メンバーを使うのと同様です。
<summary> 要約説明を識別します。\briefを使うのと同様です。
<term> <list> コマンドの一部です。
<typeparam name="paramName"> テキストを "paramName"という型引数用ドキュメントとしてマークします。\paramを使うのと同様です。
<typeparamref name="paramName"> "paramName"という名の引数を参照します。 \aを使うのと同様です。
<value> 属性を識別します。doxygenは無視します。

上記のコマンドを使ったコードをいくつか例に示します。

/// <summary>
/// 検索エンジン
/// </summary>
class Engine
{
  /// <summary>
  /// 検索メソッドは、検索の判断基準を指定した引数リストを取り、
  /// 結果のセットからなるデータセットを返却する。
  /// </summary>
  /// <param name="connectionString">検索対象となるデータベースへ
  /// 接続するための、接続文字列</param>
  /// <param name="maxRows">結果セットに返却すべき行の最大数</param>
  /// <param name="searchString">検索に使う文字列</param>
  /// <returns>条件に一致した行からなるデータセットのインスタンス
  /// maxRows引数で指定した数を最大数とする行からなる</returns>
  public DataSet Search(string connectionString, int maxRows, int searchString)
  {
    DataSet ds = new DataSet();
    return ds;
  }
}

インデックスに戻る