IDC资讯中心
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文件，因而以快速和有效的方式自动完成了烦人的任务。
