十个必备的.NET开发小工具(7):NDoc

原创 2004年09月16日 12:08:00

作者:James Avery  翻译:lucentoff

出处:http://msdn.microsoft.com/msdnmag/issues/04/07/MustHaveTools/default.aspx

声明:版权属原作者所有,转载请注明出处!

 

NDoc

 <?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

编写代码文档一直是一项令人生畏的任务。这里我并不是指设计初期的文档或更为详细的设计文档,而是指类中方法和属性的文档。NDoc工具能使用反射检查程序集并使用从C# XML注释生成的XML文档自动为你的代码生成文档。目前只有C#提供XML注释,但利用Visual Studio .NET小工具VB Commenter 可以使Visual Basic .NET具有XML注释功能。另外,Visual Studio的下一个发布版本将对更多的语言支持XML注释。

 

利用NDoc,你很容易在编写代码的同时形成文档(在XML注释中)。要使用NDoc,首先要在Visual Studio.NET中打开程序集的XML注释生成功能。右键点击项目,选择Properties | Configuration Properties | Build ,然后在“XML Documentation File”项中输入保存XML文件的路径。当项目编译时,就会创建一个包括所有XML注释的XML文件。下面是NUnit范例中一个方法的XML文档:
 

 
该方法的XML文档将被抽取并保存到XML文件中,如下所示:
 

 

NDoc利用反射查看程序集,然后读取文档中的XML并进行匹配。NDoc可使用该数据创建各种不同的文档格式,包括MSDN风格的HTML帮助文件格式(.chm)、Visual Studio .NET 帮助文件格式(HTML Help 2)等。生成XML文件之后,下一步是将程序集和XML文件加载到NDoc中以便进行处理。操作很简单,只需打开NDoc并点击“Add”按钮,然后添加相关文件即可。

 

一旦程序集和XML文件载入NDoc中并根据属性范围定制输出后,点击“Generate”按钮就开始生成文档。使用默认属性,NDoc会生成一些非常有用的.html.chm文件,因而以快速和有效的方式自动完成了烦人的任务。

 

NDoc是一个开源项目,下载网址:http://NDoc.sourceforge.net/

新.NET开发十大必备工具

Snippet Compiler ·新.Net开发必备十大工具详解之Snippet Compiler Snippet Compiler 是一个基于 Windows 的应用程序,可以通过它来编写、编...
  • paxhujing
  • paxhujing
  • 2016年06月14日 15:45
  • 1587

.NET开发常用工具大盘点

标签:.NET 概述:本文盘点了.NET开发中的常用工具、插件及管理软件。 工欲善其事,必先利其器。软件开发的第一步就是选择高效、智能的工具。下面盘点的.NET工具软件能辅助提高工...
  • jsjpanxiaoyu
  • jsjpanxiaoyu
  • 2016年03月31日 10:05
  • 3113

centos7常用工具软件安装

本文介绍了如何在centos下安装常用的一些软件,作为自己每一次探索的总结,避免以后再走弯路 。 最近centos7出了一款安装光盘,自带了很多软件包,感觉非常有用,但是还是有一些软件需要手动安装...
  • u013217146
  • u013217146
  • 2016年02月26日 18:58
  • 3574

十个必备的.NET开发小工具

本文将介绍下列工具:·  代码片段编译工具:Snippet Compiler·  正则表达式构建工具:Regulator·  代码生成工具:CodeSmith·  单元测试工具:NUnit·  代...
  • yefengmeander
  • yefengmeander
  • 2011年01月21日 13:23
  • 576

.NET开发人员十大必备下载工具

.NET开发人员十大必备下载工具,http://pcedu.pconline.com.cn/empolder/net/cs/0509/699905.html...
  • WYZSC
  • WYZSC
  • 2011年02月18日 10:14
  • 829

.NET开发人员十大必备下载工具

(1).NET开发人员十大必备下载工具         来源:http://pcedu.pconline.com.cn/empolder/net/cs/0509/699905_4.html (2)...
  • dtmine
  • dtmine
  • 2011年10月07日 21:32
  • 366

.NET开发不可错过的25款必备工具

这些年来,.NET开发团队不断在更新升级开发工具,这也提供了一个机会,让我们能对.NET系列的开发工具做出不断的评估和规范。以下是我们总结出的一些.NET开发不可错过的高效工具。...
  • u010164936
  • u010164936
  • 2015年04月27日 15:23
  • 649

.NET开发不可错过的25款必备工具

这些年来,我们的.NET开发团队不断在更新升级开发工具,这也提供了一个机会,让我们能对.NET系列的开发工具做出不断的评估和规范。以下是我们总结出的一些.NET开发不可错过的高效工具。  1.Two ...
  • shulin85
  • shulin85
  • 2011年05月03日 18:06
  • 376

每个.NET 开发人员应该下载的十个必备工具

  • 2008年06月22日 10:29
  • 222KB
  • 下载

.NET开发不可错过的25款必备工具

这些年来,我们的.NET开发团队不断在更新升级开发工具,这也提供了一个机会,让我们能对.NET系列的开发工具做出不断的评估和规范。以下是我们总结出的一些.NET开发不可错过的高效工具。 1.Two ...
  • liwei823
  • liwei823
  • 2011年08月14日 22:36
  • 204
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:十个必备的.NET开发小工具(7):NDoc
举报原因:
原因补充:

(最多只允许输入30个字)