** 作者： ** ** 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/ 。