标志名

说明

语法

参数

<summary>

对象的摘要，用于描述类型或类型成员

<summary>description</summary>

description:对象的摘要。

<remarks>

类型说明的补充信息

<remarks>description</remarks>

description:成员的说明。

<param>

用于方法声明的注释中，以描述方法的一个参数

<param name='name'>description</param>

name:方法参数名。将此名称用双引号括起来 (" ")。

description:参数说明。

<returns>

用于方法声明的注释，以描述返回值

<returns>description</returns>

description:返回值的说明。

<value>

描述属性所代表的值

<value>property-description</value>

property-description:属性的说明

<example>

指定使用方法或其他库成员的示例，通常涉及使用 <code> 标记

<example>description</example>

description: 代码示例的说明。

<code>

提供了一种将多行指示为代码的方法。

<code>content</code>

content:希望将其标记为代码的文本。

<exception>

指定哪些异常可被引发，该标记应用于方法定义。

<exception cref="member">description</exception>

cref:对可从当前编译环境中获取的异常的引用。

description:异常的说明。

<see>

从文本内指定链接

<see cref="member"/>

cref:对可以通过当前编译环境进行调用的成员或字段的引用。

<para>

<para> 标记用于诸如<summary>，<remarks> 或 <returns> 等标记内，使您得以将结构添加到文本中。

<para>content</para>

content:段落文本。

<code>*

提供了一种插入代码的方法。

<code src="src" language="lan" encoding="c"/>

src:代码文件的位置

language:代码的计算机语言

encoding:文件的编码

<img>*

用以在文档中插入图片

<img src="src"/>

src:图片的位置，相对于注释所在的XML文件

<file>*

用以在文档中插入文件，在页面中表现为下载链接

<file src="src"/>

src:文件的位置，相对于注释所在的XML文件

<localize>*

提供一种注释本地化的方法，名称与当前线程语言不同的子节点将被忽略

<localize>

 <zh-CHS>中文</zh-CHS>

 <en>English</en>

 ...

</localize>