CSDN博客

img lucentoff

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

发表于2004/7/9 17:39:00  5688人阅读

分类: .Net

作者:James Avery  翻译:lucentoff

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

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


 

NDoc

 

编写代码文档一直是一项令人生畏的任务。这里我并不是指设计初期的文档或更为详细的设计文档,而是指类中方法和属性的文档。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文档:
 
/// 
/// This test adds a number of values to the Hashtable collection 
/// and then retrieves those values and checks if they match.
/// 
[Test]
public void HashtableAddTest()
{
    //Method Body Here
}
 
该方法的XML文档将被抽取并保存到XML文件中,如下所示:
 
  This test adds a number of values to the Hashtable collection
    and then retrieves those values and checks if they match. 
 

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/
 

 
 
0 0

相关博文

我的热门文章

img
取 消
img