XML 命令

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

以下是 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> 标签组成。表格类型的列表是一个两列表格，可以有标题。
<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 方法接受一系列参数来指定搜索条件
/// 并返回包含结果集的 DataSet。
/// </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;
  }
}

转到 下一 部分或返回 索引。