这里嵌入的summary,param,returns标记仅仅是Visual Studio能够识别的一部分标记,然而在智能感知IntelliSense中,并没有把c#规范中所有的标记列出来,遗失的部分只能用手工插入。 这些手工标记是非常有用的,如果恰当地设置他们,对导出成外部说明文件将非常有帮助。
三.将注释生成XML文件
在代码中添加的注释信息, 可以单独提取出来, 生成XML文件. 在制作最后的帮助文件的时候会使用到这些注释XML文件.
默认情况下是不生成注释XML文件的.每个项目可以生成一个XML文件,需要我们在项目属性中进行设置:
如上图所示,在项目的"属性页"->"生成"中, 勾选"XML文档文件"复选框,即可在编译时生成注释XML文件.生成路径默认是和dll文件在同一个文件夹下,也可以自行修改.注意此处填写的是相对路径.
四.常见注释标签列表
注释的使用很简单,但是我们使用到的注释很少.这是因为大部分项目中注释的作用仅仅是给程序员自己看.如果想要生成类似MSDN这样的文档,我们需要了解更多的注释标签.下面是我整理的常用的注释标签: 标签名称

<summary>
说明
语法
参数
description:对象的摘要。
<summary> 标记应当用于描述<summary> 类型或类型成员。使用 Description <remarks> 添加针对某个类型</summary> 说明的补充信息。
<summary> 标记的文本是唯一有关 IntelliSense 中的类型的信息源,它也显示在 对象浏览器 中。
XML 注释的用途, 本篇文章将讲解如何使用 XML 注释 生成与 MSDN 一样的帮助... XML帮助文件 57页 4下载券 第二章XML在net里的应用 11页 免费 xml实例在...
文档注释标签用于代码创建文档使用特殊的注释字段(///)包括 XML 标记 建议的文档注释标记(18个) 第二节:XML文档注释标签的使用 与示例代码相关的文档注释标签: <...
在C#使用XML注释_IT/计算机_专业资料 暂无评价0人阅读0次下载举报文档 在C#使用XML注释_IT/计算机_专业资料。今日推荐 157份文档 ...
使用xml作注释名称_IT/计算机_专业资料。使用XML为FLEX地图作注释... Asp.Net中几种相似的标记... 2页 免费 LRU处理缺页中断 C 2页 7下载券...
注释配置不一定在先天上优于 XML 配置。如果 Bean 的依赖关系是固定的,(如 Service 使用了哪几个 DAO 类),这种配置信息不会在部署时发生调整,那么注 释配置...
基本技术 记录您的代码使用 XML 注释 Lisa Feigenbaum 这篇文章部分基于 Visual ...Microsoft 使用 XML 注释生成的所有 Microsoft.NET Framework 程序集的文档。 XML...
使用.NET 中的 XML 注释 一) --XML 注释标签讲解 注释(一 使用 一.摘要 .Net 允许开发人员在源代码中插入 XML 注释,这在多人协作开发的时候显得特 别有用...
.Net中的XmlReader与XmlWriter解析 XML在.NET Framework 中有着重要的作用。如:.NET Framwork 本身的配置文件和源代码文档中使用XML,SOAP、WEB服务和ADO.NET也使用...
使用.NET 中的 XML 注释 一) -- XML 注释标签讲解 注释(一 使用 一.摘要 .Net 允许开发人员在源代码中插入 XML 注释,这在多人协作开发的时候显得特别有用。...
本章主要介绍XML的语 法、属性和注释。还有LINQ操作XML文件,以及 XML与ADO.NET...</people> XML文档由一个XML声明和包含一些嵌套元素的一个根元素或标签构成。 ...
热门文档