XML 指令

Doxygen 支援 C# 程式碼註解中常用的多數 XML 指令。這些 XML 標籤定義於 ECMA-334 標準的附錄 D 中，該標準定義了 C# 語言。不幸的是，該規範並不是很精確，而且給出的一些範例品質不佳。

以下是 Doxygen 支援的標籤列表

XML 指令	描述
<c>	識別應呈現為程式碼片段的行內文字。與使用 <tt>文字</tt> 類似。
<code>	設定一行或多行原始碼或程式輸出。請注意，此指令對於 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 的列表是一個兩欄的表格，可以有標題。
<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[...]]>	此標籤內的文字（位於 ... 上）被視為正常的 Doxygen 註解，但 XML 特殊字元 <、> 和 & 除外，它們的使用方式如同它們被逸脫一樣。

以下是使用上述一些指令的典型程式碼片段範例

/// <summary>
/// 一個搜尋引擎。
/// </summary>
class Engine
{
/// <summary>
/// Search 方法會接收一系列參數來指定搜尋條件
/// 並傳回包含結果集的資料集。
/// </summary>
/// <param name="connectionString">用於連線至
/// 資料庫的連線字串，其中包含要搜尋的內容</param>
/// <param name="maxRows">要
/// 在結果集中傳回的最大列數</param>
/// <param name="searchString">我們要搜尋的文字</param>
/// <returns>包含相符列的 DataSet 執行個體。它包含由 maxRows 參數指定的最大
/// 列數</returns>
  public DataSet Search(string connectionString, int maxRows, int searchString)
  {
DataSet ds = new DataSet();
    return ds;
  }
}

前往下一節或返回索引。