XML 命令

Doxygen 支持 C# 代码注释中常用的大部分 XML 命令。XML 标签在 ECMA-334 标准的附录 D 中定义，该标准定义了 C# 语言。遗憾的是，该规范不是很精确，并且给出的一些示例质量较差。

以下是 Doxygen 支持的标签列表

XML 命令	描述
<c>	标识应作为代码片段呈现的行内文本。类似于使用 <tt>text</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">	开始一个“另请参见”部分，引用“成员”。类似于使用 \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;
  }
}

转到下一节或返回索引。