C#注释标签

文档型注释

创新互联是一家集网站建设,盐亭企业网站建设,盐亭品牌网站建设,网站定制,盐亭网站建设报价,网络营销,网络优化,盐亭网站推广为一体的创新建站企业,帮助传统企业提升企业形象加强企业竞争力。可充分满足这一群体相比中小企业更为丰富、高端、多元的互联网需求。同时我们时刻保持专业、时尚、前沿,时刻以成就客户成长自我,坚持不断学习、思考、沉淀、净化自己,让我们为更多的企业打造出实用型网站。

该类注释采用.Net已定义好的Xml标签来标记,在声明接口、类、方法、属性、字段都应该使用该类注释,以便代码完成后直接生成代码文档,让别人更好的了解代码的实现和接口。如

///

MyMethod is a method in the MyClass class.

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

///

///for information about output statements.

///

///

///

public static void MyMethod(int Int1)

{

}

单行注释(略...)

注释标签*


标签
作用用法

description

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

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

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

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

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


description

description代码示例的说明。

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

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

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

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

id

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

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

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

term

description

term

description

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

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

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

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

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

description

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

description 成员的访问的说明。

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

description

description 成员的说明。


property-description

property-description 属性的说明。







网站栏目:C#注释标签
URL网址:http://pwwzsj.com/article/jpjeie.html