吉吉于

free

C#之注释

06 Feb 2012

以前只会//或者是/**/注释，其实还有很多种注释方法，今天研究了一下，写个总结，便于以后参考。

summary注释没动过，每次都要删除，其实挺有用的。
在类,方法或属性定义的上一行输入///自动填充，在调用的时候会有说明，如图：

<summary>

[][1]</summary>

注释解析：

</tr> </tr>

标签	用法	作用
</span> </td>	c>text</c></p> text 希望将其指示为代码的文本。</td>	为您提供了一种将说明中的文本标记为代码的方法。使用 `</a> 将多行指示为代码</span> </td></tr>`
</span> </td>	content</p> content段落文本。</td>	用于诸如 <remarks> 或 </a> 等标记内，使您得以将结构添加到文本中。</span> </td></tr>
	<param name=’name‘>description</param></p> name 为方法参数名。将此名称用单引号括起来 (‘ ‘)。</td>	应当用于方法声明的注释中，以描述方法的一个参数。
</span></p> </td>	<paramref name=”name“/></p> name 要引用的参数名。将此名称用双引号括起来 (” “)。</td>	标记为您提供了一种指示词为参数的方法。可以处理 XML 文件，从而用某种独特的方法格式化该参数。</span> </td></tr>
</span> </td>	<see cref=”member“/></p> cref = “member” 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 (” “) 中。</td>	使您得以从文本内指定链接。使用 </a> 指示希望在"请参阅"一节中出现的文本。</span> </td></tr>
</span> </td>	<seealso cref=”member“/></p> cref = “member” 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 (” “) 中</td>	使您得以指定希望在"请参阅"一节中出现的文本。使用 </a> 从文本</span> </td></tr>
</span> </td>	description</p> description 代码示例的说明。</td>	使用标记可以指定使用方法或其他库成员的示例。一般情况下，这将涉及到 `</a> 标记的使用。</span> </td></tr>`
`</span> </td>`	`content`</p> content 为希望将其标记为代码的文本。 </td>	记为您提供了一种将多行指示为代码的方法。使用 </a> 指示应将说明中的文本标记为代码</span> </td></tr>
</span> </td>	description </p> 此处description 为对象的摘要。</td>	应当用于描述类型成员。使用 <remarks> 以提供有关类型本身的信息。
</span> </td>	<exception cref=”member“>description</exception></p> cref = “member” 对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后，将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (” “) 中。 description 说明。</td>	标记使您可以指定类能够引发的异常。</span> </td></tr>
</span> </td>	<include file=’filename‘ path=’tagpath[@name="id"]‘ /></p> filename 包含文档的文件名。该文件名可用路径加以限定。将 filename 括在单引号中 (‘ ‘)。 Tagpath：filename 中指向标记名的标记路径。将此路径括在单引号中 (‘ ‘)。 name 注释前边的标记中的名称说明符；名称具有一个 id。 id 位于注释之前的标记的 id。将此 id 括在双引号中 (” “)。</td>	标记使您得以引用描述源代码中类型和成员的另一文件中的注释。这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。</span></p> 标记使用 XML XPath 语法。有关自定义使用的方法，请参阅 XPath 文档。</span></td> </tr>
</span> </td>	<list type=”bullet” \| “number” \| “table”></p> </span> </p> term description </listheader> </span> </p> term description</description></span> </p> </item> </list> term 定义的项，该项将在 text 中定义。 description 目符号列表或编号列表中的项或者 term 的定义。</td>	块用于定义表或定义列表中的标题行。定义表时，只需为标题中的项提供一个项。</span></p> 列表中的每一项用块指定。创建定义列表时，既需要指定 term 也需要指定 text。但是，对于表、项目符号列表或编号列表，只需为 text 提供一个项。</span> </p> 列表或表所拥有的块数可以根据需要而定。</span></td> </tr>
</span> </td>	<permission cref=”member“>description</permission></p> cref = “member” 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (” “) 中。 description 成员的访问的说明。</td>	标记使您得以将成员的访问记入文档。System.Security.PermissionSet 使您得以指定对成员的访问。</span> </td></tr>
<remarks>	<remarks>description</remarks></p> description 成员的说明。</td>	<remarks> 标记是可以指定有关类或其他类型的概述信息的位置。 </a> 是可以描述该类型的成员的位置。</span> </td></tr>
</span> </td>	description</p> description 返回值的说明。</td>	标记应当用于方法声明的注释，以描述返回值。</span> </td></tr>
</span> </td>	property-description</p> property-description 属性的说明。</td>	标记使您得以描述属性。请注意，当在 Visual Studio .NET 开发环境中通过代码向导添加属性时，它将会为新属性添加 </a> 标记。然后，应该手动添加标记以描述该属性所表示的值。</span> </td></tr> </tbody> </table> 转载请注明：于哲的博客 » C#之注释 [1]: http://lazynight.me/wp-content/uploads/2012/02/summary.gif