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

转载 2004年07月13日 10:54: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
  • 1598

Windows Vista/7桌面边栏小工具开发入门

Windows Vista 的Gadget开发其实并不难,只要你有一定的HTML、CSS、Javascript基础就能成功地开发出一个漂亮的桌面小工具。在Vista和Win7下,每一个桌面Gadget...
  • mrxyz098
  • mrxyz098
  • 2014年06月01日 20:48
  • 1888

CentOS 7常用工具安装

git在Linux下开发项目,少不了要使用git工具,安装方法十分简单,通过一条 yum 指令既可完成安装:yum install git安装完成后检测版本:# git --version git v...
  • linshuhe1
  • linshuhe1
  • 2017年07月21日 13:35
  • 874

程序员必备的11个辅助开发的软件神器

前言(欢迎评论区列出你认为牛逼的开发神器~) 本文来自MeloDev的投稿,他的博客地址: http://www.jianshu.com/u/f5909165c1e8程序员必备简捷开发辅助工具总结...
  • u010321471
  • u010321471
  • 2017年11月28日 00:39
  • 1620

python小工具

http://blog.csdn.net/pipisorry/article/details/46754515python复制、删除文件代码、python代码出错重启python遍历和删除指定目录下所...
  • pipisorry
  • pipisorry
  • 2015年07月04日 11:57
  • 2229

android 桌面小工具(Widget)开发教程

刚学做了个Widget,感觉不错哦,先来秀下效果(用朋友手机截的图) 这个Widget会每隔5秒钟自动切换内容和图片,图片最好使用小图,大图会导致你手机桌面(UI)线程卡顿 ...
  • wuhongqi0012
  • wuhongqi0012
  • 2014年02月20日 09:29
  • 1513

这些小工具让你的Android 开发更高效

在做Android 开发过程中,会遇到一些小的问题,虽然自己动手也能解决,但是有了一些小工具,解决这些问题就得心应手了,今天就为大家推荐一下Android 开发遇到的小工具,来让你的开发更高效。...
  • tikitoo
  • tikitoo
  • 2016年04月07日 21:04
  • 20024

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

NET 开发人员应该下载的十个必备工具  文章出处:联动天下 作者:联动天下 发布时间:2005-12-21  NUnit:编写单元测试的工具  NDoc:创建代码文档的工具  NAnt:生成...
  • u014440119
  • u014440119
  • 2014年04月19日 15:42
  • 221

Android开发必备知识

为方便查找,已进行大致归类,其目录如下所示: 尺寸相关 dp与px转换 dp2px、px2dpsp与px转换 sp2px、px2sp各种单位转换 applyDimension在onCr...
  • Daiwilliam
  • Daiwilliam
  • 2016年12月26日 11:06
  • 561

Web前端开发必备网站

大牛博客阮一峰博客: http://www.ruanyifeng.com/blog/愚人码头博客: http://www.css88.com/张鑫旭博客:http://www.zhangxinxu.c...
  • lijiajun95
  • lijiajun95
  • 2017年01月01日 21:09
  • 832
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:十个必备的.NET开发小工具(7):NDoc
举报原因:
原因补充:

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