C#注释标签-创新互联

文档型注释

创新互联自2013年起，先为嵩明等服务建站，嵩明等地企业，进行企业商务咨询服务。为嵩明企业网站制作PC+手机+微官网三网同步一站式服务解决您的所有建站问题。

该类注释采用.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 属性的说明。

另外有需要云服务器可以了解下创新互联scvps.cn，海内外云服务器15元起步，三天无理由+7*72小时售后在线，公司持有idc许可证，提供“云服务器、裸金属服务器、高防服务器、香港服务器、美国服务器、虚拟主机、免备案服务器”等云主机租用服务以及企业上云的综合解决方案，具有“安全稳定、简单易用、服务可用性高、性价比高”等特点与优势，专为企业上云打造定制，能够满足用户丰富、多元化的应用场景需求。

当前文章：C#注释标签-创新互联
分享地址：http://scyanting.com/article/hiego.html

C#注释标签-创新互联

单行注释(略...)

其他资讯