使用XML记录您的代码.pdfVIP

记录您的代码使用 XML 注释 Page 1 of 7 ©2009 Microsoft Corporation. All rights reserved. 此为机器翻译内容。 基本技术 记录您的代码使用 XML 注释 Lisa Feigenbaum 这篇文章部分基于 Visual Studio 的预发布版本。如更改，恕所有信息。 内容 XML 注释基础知识 XML 自定义 注释 生成 XML 文档文件 增强 Visual Studio 和 XML 注释 注释的优点 Else 某人的代码 .NET Framework 中的技巧 生成 Nicer 文档 XML 注释在 Visual Studio 2010 查找文档您的代码的简单而有效的方法？ XML 注释提供很好的解决方案。在 Visual Studio 2005 中最先引 入 Visual Basic 的 XML 注释。它们可以用创建该的项目文档文件，并为您自己、您的 teammates 或使用 您的代码的其他人提供丰富的开发环境体验。 此文章中 我将向您介绍 注释，并介绍了如何使用它们。我将探讨的 注释可用于自定义编码环 , XML XML 境，并从代码中的注释中创建文档文件的方法。我还将显示您将创建用于处理 XML 注释在代码中更好体验 的某些将来 Visual Studio 功能。 XML 注释基础知识 XML 注释可用于对文档除了命名空间的几乎所有定义。这包括类型 （类、模块、接口、 结构、枚举、委 字段 、属性 （属性）、事件 （事件）和方法 （ 、函数、声明运算符）。 托）、 (Dim) Sub XML 注释是直接在源代码中的插入嵌入式。 这使得更易于随着代码发展使其保持必威体育精装版。要插入的 XML 注 释，键入三个报价单标记 () 正上方定义，如下： 复制代码 Function RegKeyExists(ByVal regKey As String) As Boolean Dim exists As Boolean = False Try ... 此外，还可以键入 的开头定义行，然后按 。 将插入要填充的 注释的一个框架。 Enter Visual Studio XML 复制代码 summary /summary param name=regKey/praram returns/returns remarks/remarks Function RegKeyExists(ByVal regKey As String) As Boolean Dim exists As Boolean = False Try ... 这篇文章的目的我使用简单的函数使用一个参数演示 XML 注释功能。根据定义，XML 框架变化。例如， XML 主干为函数包含一个返回元素，而不是为一个子框架。为方法参数标记的数量也异参数的数目。 请注意尽管 V