XML文档注释演示

XML文档注释演示

ID:41105834

大小:223.12 KB

页数:16页

时间:2019-08-16

XML文档注释演示_第1页
XML文档注释演示_第2页
XML文档注释演示_第3页
XML文档注释演示_第4页
XML文档注释演示_第5页
资源描述:

《XML文档注释演示》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库

1、XML文档注释标签演示提纲第一部分:XML文档注释标签的使用第二部分:.NETAPI文档生成工具的使用第一部分:XML文档注释标签的使用第一节:什么是XML文档注释标签用于代码创建文档使用特殊的注释字段(///)包括XML标记建议的文档注释标记(18个)第二节:XML文档注释标签的使用与示例代码相关的文档注释标签::将说明中的文本标记为代码:将多行指示为代码。:指定使用方法或其他库成员的示例。与方法声明相关的文档注释标签::用于方法声明的注释中,以描述方法的一个参数。

2、标记的文本将显示在IntelliSense、对象浏览器和代码注释Web报表中。:指示代码注释中的某个单词引用某个参数的方式。可以处理XML文件来以不同的方式格式化此单词,比如将其设置为粗体或斜体。:用于方法声明的注释,以描述返回值。:用于泛型类型或方法声明的注释中,以描述泛型类型或方法的类型参数标记的文本将显示在对象浏览器代码注释Web报表的IntelliSense中。:泛型类型或方法声明的注释

3、中,用于设置单词的格式与异常相关的文档注释标签::指定哪些异常可被引发。此标记可用在方法、属性、事件和索引器的定义中。与文本结构相关的文档注释标签::创建列表:创建段落文本。与类型描述信息相关的文档注释标签:

:用于描述类型或类型成员。标记的文本是唯一有关IntelliSense中的类型的信息源,它也显示在对象浏览器中。:用于添加有关某个类型的信息,从而补充由所指定的信息。(备注)与链接相关的文档注释

4、标签::从文本内指定链接。:指示文本应该放在“另请参见”节中。与属性相关的文档注释标签:value:描述属性所代表的值。与权限相关的文档注释标签:Permission:将成员的访问记入文档。使用PermissionSet类可以指定对成员的访问。第二部分:.NETAPI文档生成工具的使用第一节:文档生成工具软件介绍CHM编译工具:HTMLHelpWorkshop.NETAPI文档生成工具:SandcastleSandcastle的GUI界面编译工具:SandcastleHelpFileBui

5、lderDLL文件XMl文件SandcastleHelpFileBuilderSandcastleHTML文件HTMLHelpWorkshopCHM文件HTMLHelpWorkshop第二节:CHM编译工具:HTMLHelpWorkshop1:MicrosoftHTMLHelpWorkshop是由微软公司出的编程配套的软件。2:该软件可以帮助您建立HTML格式(*.chm)的HELP文件。3:并可以把HTML格式的HELP文件(*.chm)反编译成单个的HTML文件。第三节:.NETAPI文档生成工具:Sandcas

6、tle1:Sandcastle是一个微软发布的工具,它通过反射程序集中的源代码以及添加代码中的XML注释来创建MSDN形式的API文档。2:这个工具的源代码可以在CodePlex中以微软公开许可协议(MicrosoftPublicLicense)下获得。3:Sandcastle能够在命令行或GUI工具里生成文档第四节:Sandcastle的GUI界面编译工具:SandcastleHelpFileBuilder1:SandcastleHelpFileBuilder是微软发布的一个用于Sandcastle的可视化界面编译

7、工具。这个工具的源代码可以在CodePlex中以微软公开许可协议(MicrosoftPublicLicense)下获得。2:使用SandcastleHelpFileBuilder能够简化对Sandcastle和HTMLHelpWorkshop这些命令行工具的操作。第五节.NETAPI文档的生成1:在项目里添加XML文档注释标签。设置项目属性为输出XML文档。2:在“SandcastleHelpFileBuilder”里创建一个新项目,并添加对VS2008项目的生成文件(dll和XML)和项目所引用程序集的引用。3:设

8、置SandcastleHelpFileBuilder的相关属性。4:编译生成CHM文件。

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。