工具书,文集,丛书,教材,教辅
本文由zhoupeng35贡献
doc文档可能在WAP端浏览体验不佳。建议您优先选择TXT,或下载源文件到本机查看。
使用.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 将自动插入注释标记,开发人员只 需要增加些额外的标记和值。下面就是在成员函数前增加三个斜线,自动增加的注释比如:
///
/// 得到指定酒店的酒店信息
///
///
酒店 Id
///
语言码.中文为 zh-cn
/// <returns>酒店信息对象</returns>
[OperationContract]
OutHotelInfo GetHotelInfoByHotelId(string loginName, string loginPassword, string hotel
Id, string languageCode);
这里嵌入的 summary,param,returns 标记仅仅是 Visual Studio 能够识别的一部分标记,然而在 智能感知 IntelliSense 中,并没有把 c#规范中所有的标记列出来,遗失的部分只能用手工插入。 这 些手工标记是非常有用的,如果恰当地设置他们,对导出成外部说明文件将非常有帮助。
三.将注释生成 XML 文件
在代码中添加的注释信息, 可以单独提取出来, 生成 XML 文件. 在制作最后的帮助文件的时候会 使用到这些注释 XML 文件.
默
donet通过注释生成帮助文档donet通过注释生成帮助文档隐藏>> 分享到: X 分享到: 使用一键分享,轻松赚取财富值, 了解详情 嵌入播放器: 普通尺寸(450*500pix)...
加入会员!获取文档下载券 donet通过注释生成帮助文档 高考化学考点解析全程复习考点: 硫酸工业 环境保护高考化学考点解析全程复习考点: 硫酸工业 环境保护隐藏>> 本...
donet通过注释生成帮助文档... 21页 免费 DoNet 8页 免费 DONET体系 19页 5财富值 深入donet控件 50页 1财富值 DONET应用服务 3页 2财富值...
2页 1财富值 donet通过注释生成帮助文档... 21页 免费 Donet面试题 85页 1财富值 DONET面试题 27页 2财富值喜欢此文档的还喜欢 《C#程序设计基础》习题库....
donet通过注释生成帮助文档... 21页 免费 donet测试 10页 1财富值搜你所想,读你所爱 拒绝盗版,营造绿色文库 如要投诉违规内容,请到百度文库投诉中心;如要...
donet通过注释生成帮助文档... 21页 免费 donet测试 10页 1财富值...【规则 3-4】注释使用//,不使用//---或者//***。 〖建议 3-1〗所有的...
DONET面试题 27页 2财富值 donet测试 10页 1财富值 donet通过注释生成帮助文档... 21页 免费 架构设计六技 暂无评价 41页 1财富值喜欢此文档的还喜欢...
41页 1财富值 Donet面试题 85页 1财富值 donet通过注释生成帮助文档... 21页 免费 donet测试 10页 1财富值 DoNet 自定义应用程序配置 50页 2财富值...
DONET架构设计六技 41页 1财富值 DONET面试题 27页 2财富值 donet测试 10页 1财富值 donet通过注释生成帮助文档... 21页 免费喜欢此文档的还喜欢...
donet通过注释生成帮助文... 21页 免费 Donet面试题 85页 1下载券 DONET面试题 27页 1下载券 喜欢此文档的还喜欢 软件公司实习报告2010 3页 免费 计算机毕业...
热门文档