使用.NET中的XML注释(一) -- XML注释标签讲解
一.摘要
.Net允许开发人员在源代码中插入XML注释,这在多人协作开发的时候显得特别有用。 C#解析器可以把代码文件中的这些XML标记提取出来,并作进一步的处理为外部文档。 这篇文章将展示如何使用这些XML注释。 在项目开发中,很多人并不乐意写繁杂的文档。但是,开发组长希望代码注释尽可能详细;项目规划人员希望代码设计文档尽可能详尽;测试、检查人员希望功能说明书尽可能详细等等。如果这些文档都被要求写的话,保持它们同步比进行一个战役还痛苦。
为何不把这些信息保存在一个地方呢??最明显想到的地方就是代码的注释中;但是你很难通览程序,并且有些需要这些文档的人并不懂编码。最好的办法是通过使用XML注释来解决这些问题。代码注释、用户手册、开发人员手册、测试计划等很多文档可以很方便的从XML注释中获得。本文讲解.Net中经常使用的XML注释.主要使用C#语言j,.Net平台支持的其他语言使用的XML注释格式基本相同.并且在本系列文章的下一讲中讲解如何使用工具将XML注释内容转化为帮助文档.
二.XML注释概述
所有的XML注释都在三个向前的斜线之后(///)。两条斜线表示是一个注释,编译器将忽略后面的内容。三条斜线告诉编译器,后面是XML注释,需要适当地处理。
当开发人员输入三个向前的斜线后,Microsoft Visual Studio .NET IDE 自动检查它是否在类或者类成员的定义的前面。如果是的话,Visual Studio .NET IDE 将自动插入注释标记,开发人员只需要增加些额外的标记和值。下面就是在成员函数前增加三个斜线,自动增加的注释比如:
/// <summary>
/// 得到指定酒店的酒店信息 /// </summary>
/// <param name="hotelId">酒店Id</param>
/// <param name="languageCode">语言码.中文为zh-cn</param>
/// <returns>酒店信息对象</returns> [OperationContract]
OutHotelInfo GetHotelInfoByHotelId(string loginName, string loginPassword, string hotelId, string languageCode);
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声明和包含一些嵌套元素的一个根元素或标签构成。 ...
热门文档