.NET C#代码注释标签

来源：互联网发布：网络歌曲黑名单编辑：程序博客网时间：2024/06/04 23:33

转自 http://aonaufly.blog.51cto.com/3554853/1301062

使用标签有助于自动生成文档！

///<summary>MyMethod is a method in the MyClass class.

///<para>Here's how you could make a second paragraph in a description.

///<see cref="System.Console.WriteLine"/>

///for information about output statements.

///</para>

///<seealso cref="MyClass.Main"/>

///</summary>

public static void MyMethod(int Int1)

{

}

单行注释(略...)

注释标签*

标签
作用用法<param>

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

name 为方法参数名。将此名称用单引号括起来(' ')。

应当用于方法声明的注释中，以描述方法的一个参数。<see>

cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出XML 中的元素名。必须将 member 括在双引号 (" ") 中。

使您得以从文本内指定链接<seealso>

cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出XML 中的元素名。必须将 member 括在双引号 (" ") 中

<example>description</example>

description代码示例的说明。

使用 <example> 标记可以指定使用方法或其他库成员的示例。一般情况下，这将涉及到 <code>标记的使用。<include>

filename 包含文档的文件名。该文件名可用路径加以限定。将 filename 括在单引号中 (' ')。

Tagpath：filename 中指向标记名的标记路径。将此路径括在单引号中 (' ')。

name 注释前边的标记中的名称说明符；名称具有一个 id。

位于注释之前的标记的 id。将此 id 括在双引号中 (" ")。

<include> 标记使您得以引用描述源代码中类型和成员的另一文件中的注释。这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。

<include> 标记使用 XML XPath 语法。有关自定义 <include> 使用的方法，请参阅 XPath 文档。

<list>

<description>description</description>

</listheader>

<item>

<description>description</description>

</item>

</list>

term 定义的项，该项将在 text 中定义。

description 目符号列表或编号列表中的项或者 term 的定义。

<listheader> 块用于定义表或定义列表中的标题行。定义表时，只需为标题中的项提供一个项。

列表中的每一项用 <item> 块指定。创建定义列表时，既需要指定 term 也需要指定 text。但是，对于表、项目符号列表或编号列表，只需为 text 提供一个项。

列表或表所拥有的 <item> 块数可以根据需要而定。

<permissioncref="member">description</permission>

cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 转换为输出XML 中的规范化元素名。必须将 member 括在双引号 (" ") 中。

description 成员的访问的说明。

<permission> 标记使您得以将成员的访问记入文档。System.Security.PermissionSet使您得以指定对成员的访问。<remarks>

<remarks>description</remarks>

description 成员的说明。

<value>

<value>property-description</value>

property-description 属性的说明。

0 0