XML文档注释演示ppt课件

1、XML文档注释标签演示;提纲第一部分： XML 文档注释标签的使用第二部分： .NET API文档生成工具的使用;第一部分：XML 文档注释标签的使用第一节：什么是XML文档注释标签用于代码创建文档使用特殊的注释字段(/)包括 XML 标记建议的文档注释标记(18个);第二节：XML文档注释标签的使用与示例代码相关的文档注释标签： 将说明中的文本标记为代码：将多行指示为代码。： 指定使用方法或其他库成员的示例。;与方法声明相关的文档注释标签：用于方法声明的注释中，以描述方法的一个参数。 标记的文本将显示在 IntelliSense、对象浏览器和代码注释 Web 报表中。：指示代码注释中的某个单

2、词引用某个参数的方式。可以处理 XML 文件来以不同的方式格式化此单词，比如将其设置为粗体或斜体。： 用于方法声明的注释，以描述返回值。：用于泛型类型或方法声明的注释中，以描述泛型类型或方法的类型参数 标记的文本将显示在 对象浏览器代码注释 Web 报表的 IntelliSense 中。：泛型类型或方法声明的注释中，用于设置单词的格式;与异常相关的文档注释标签：指定哪些异常可被引发。此标记可用在方法、属性、事件和索引器的定义中。;与文本结构相关的文档注释标签：创建列表：创建段落文本。;与类型描述信息相关的文档注释标签： 用于描述类型或类型成员。 标记的文本是唯一有关 IntelliSense

3、中的类型的信息源，它也显示在 对象浏览器中。： 用于添加有关某个类型的信息，从而补充由 所指定的信息。(备注);与链接相关的文档注释标签：从文本内指定链接。：指示文本应该放在“另请参见”节中。;与属性相关的文档注释标签：value：描述属性所代表的值。;与权限相关的文档注释标签：Permission：将成员的访问记入文档。使用 PermissionSet 类可以指定对成员的访问。;第二部分： .NET API文档生成工具的使用第一节：文档生成工具软件介绍CHM编译工具：编译工具：HTML Help Workshop.NET API文档生成工具：文档生成工具：SandcastleSandcast

4、le的的GUI界面编译工具：界面编译工具：Sandcastle Help File BuilderDLL 文件XMl 文件Sandcastle Help File BuilderSandcastleHTML文件HTML Help WorkshopCHM 文件HTML Help Workshop;第二节：CHM编译工具：编译工具：HTML Help Workshop1：Microsoft HTML Help Workshop 是由微软公司出的编程配套的软件。2：该软件可以帮助您建立 HTML 格式(*.chm)的 HELP 文件。3：并可以把HTML格式的HELP 文件(*.chm)反编译成单个

5、的HTML文件。;第三节： .NET API文档生成工具：文档生成工具：Sandcastle1：Sandcastle是一个微软发布的工具，它通过反射程序集中的源代码以及添加代码中的XML注释来创建MSDN形式的API文档。2：这个工具的源代码可以在CodePlex中以微软公开许可协议（Microsoft Public License）下获得。3：Sandcastle能够在命令行或GUI工具里生成文档;第四节： Sandcastle的的GUI界面编译工具：界面编译工具： Sandcastle Help File Builder1：Sandcastle Help File Builder是微软发布的一个用于Sandcastle的可视化界面编译工具。这个工具的源代码可以在CodePlex中以微软公开许可协议（Microsoft Public License）下获得。2：使用Sandcastle Help File Builder能够简化对Sandcastle和HTML Help Workshop这些命令行工具的操作。;第五节.NET API文档的生成文档的生成1：在项目里添加XML文档注释标签。设置项目属性为 输出XML文档。2：在“Sandcastle Help File Builder”里创建一个新项目，并添加