文档下载 文档下载导航
设为首页 | 加入收藏
搜索 请输入内容:  
 导航当前位置: 文档下载 > 所有分类 > IT/计算机 > 计算机软件及应用 > 使用.NET中的XML注释(一) -- XML注释标签讲解
侵权投诉

使用.NET中的XML注释(一) -- XML注释标签讲解

<remarks> 使用 <remarks> 标记添加有关<remarks> 类型的信息,以此补充用 Description <summary> 指定的信息。此信息</remarks> 显示在对象浏览器中。

description:成员的说明。

<param> <param> 标记应当用于方法声<param name='name'> 明的注释中,以描述方法的一个description 参数。

有关 <param> 标记的文本将显示在 IntelliSense、对象浏览器和代码注释 Web 报表中。

</param>

name:方法参数名。将此名称用双引号括起来 (" ")。 description:参数说明。

<returns> <returns> 标记应当用于方法<returns> 声明的注释,以描述返回值。

description:返回值的说明。

Description </returns>

<value> <value> 标记使您得以描述属<value>

property-description:属性的说

性所代表的值。请注意,当在 property-description 明 Visual Studio .NET 开发环境</value> 中通过代码向导添加属性时,它将会为新属性添加 <summary> 标记。然后,应该手动添加 <value> 标记以描述该属性所表示的值。

使用 <example> 标记可以指定<example> 使用方法或其他库成员的示例。Description 这通常涉及使用 <code> 标记。 </example>

<example> description: 代码示例的说明。

<c> <c> 标记为您提供了一种将说<c> 明中的文本标记为代码的方法。Text 使用 <code> 将多行指示为代</c> 码。

text :希望将其指示为代码的文本。

<code> 使用 <code> 标记将多行指示<code> 为代码。使用<c>指示应将说明Content 中的文本标记为代码。

content:希望将其标记为代码的文本。

</code> <exception cref="member"> Description </exception>

<exception> <exception> 标记使您可以指

定哪些异常可被引发。此标记可用在方法、属性、事件和索引器的定义中。

cref:

对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后,将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (" ") 中。

有关如何创建对泛型类型的 cref 引用的更多信息,请参见 <see> description:异常的说明。

上一页第3页

你可能喜欢

热门文档

相关文档

  • 使用.NET中的XML注释(二) -- 创建帮助文档入门篇

    XML 注释的用途, 本篇文章将讲解如何使用 XML 注释 生成与 MSDN 一样的帮助... XML帮助文件 57页 4下载券 第二章XML在net里的应用 11页 免费 xml实例在...

  • XML 文档注释演示

    文档注释标签用于代码创建文档使用特殊的注释字段(///)包括 XML 标记 建议的文档注释标记(18个) 第二节:XML文档注释标签的使用 与示例代码相关的文档注释标签: <...

  • 在C#使用XML注释

    在C#使用XML注释_IT/计算机_专业资料 暂无评价0人阅读0次下载举报文档 在C#使用XML注释_IT/计算机_专业资料。今日推荐 157份文档 ...

  • 使用xml作注释名称

    使用xml作注释名称_IT/计算机_专业资料。使用XML为FLEX地图作注释... Asp.Net中几种相似的标记... 2页 免费 LRU处理缺页中断 C 2页 7下载券...

  • 注释配置和 XML 配置的适用场合

    注释配置不一定在先天上优于 XML 配置。如果 Bean 的依赖关系是固定的,(如 Service 使用了哪几个 DAO 类),这种配置信息不会在部署时发生调整,那么注 释配置...

  • 使用XML记录您的代码

    基本技术 记录您的代码使用 XML 注释 Lisa Feigenbaum 这篇文章部分基于 Visual ...Microsoft 使用 XML 注释生成的所有 Microsoft.NET Framework 程序集的文档。 XML...

  • donet通过注释生成帮助文档

    使用.NET 中的 XML 注释 一) --XML 注释标签讲解 注释(一 使用 一.摘要 .Net 允许开发人员在源代码中插入 XML 注释,这在多人协作开发的时候显得特 别有用...

  • .Net中的XmlReader与XmlWriter解析

    .Net中的XmlReader与XmlWriter解析 XML在.NET Framework 中有着重要的作用。如:.NET Framwork 本身的配置文件和源代码文档中使用XML,SOAP、WEB服务和ADO.NET也使用...

  • donet通过注释生成帮助文档

    使用.NET 中的 XML 注释 一) -- XML 注释标签讲解 注释(一 使用 一.摘要 .Net 允许开发人员在源代码中插入 XML 注释,这在多人协作开发的时候显得特别有用。...

  • 第7章 XML简介

    本章主要介绍XML的语 法、属性和注释。还有LINQ操作XML文件,以及 XML与ADO.NET...</people> XML文档由一个XML声明和包含一些嵌套元素的一个根元素或标签构成。 ...

站点地图 | 文档上传 | 侵权投诉 | 手机版
本站所有资源均来自互联网,本站只负责收集和整理,均不承担任何法律责任,如有侵权等其它行为请联系我们.
文档下载 Copyright 2013 doc.guandang.net All Rights Reserved.  -  email