开发工具之文档生成---Ndoc简介

    NDoc是一个.NET代码文档生成工具，有点象JDoc,但这个是在.NET下的工具。
    NDoc使用Visual Studio.NET开发过程中生成的程序集和XML文档来生成一些格式象Visual Studio.NET和.NET Frmaework SDK在线帮助文档那样的一些编译后的HTML帮助文档。
它是一个OpenSource的项目，在http://ndoc.sourceforge.net可以下载到SourceCode。
使用十分简单，例如创建一个简单的项目来看NDoc可以为我们做些什么？

    打开vs,新建一个控制台应用程序.假设为:NdocTest,代码如下:

using System;
using System.Collections.Generic;
using System.Text;

namespace NdocTest
{
    /**//// <summary>
    /// 测试类
    /// </summary>
    public class Program
    {
        /**//// <summary>
        /// 程序的入口
        /// </summary>
        static void Main(string[] args)
        {
            Person person = new Person();
            person.Name = "cat";
            person.Age = "21";
            Console.WriteLine(person);
            Console.Read();
        }
    }
    /**//// <summary>
    /// 人
    /// </summary>
    public class Person
    {
        private string name;
        private string age;
        /**//// <summary>
        /// 姓名
        /// </summary>
        public string Name
        {
            get { return name; }
            set { name = value; }
        }
        /**//// <summary>
        /// 年龄
        /// </summary>
        public string Age
        {
            get { return age; }
            set { age = value; }
        }
        /**//// <summary>
        /// 输出姓名和年龄
        /// </summary>
        /// <returns></returns>
        public override string ToString()
        {
            return name + "@" + age;
        }
    }
}

    为了使用NDoc生成文档，必须有一个编译后的程序集和一个导出的XML文件，要生成这个XML文件，必须在项目属性中将生成XML文件的选项填上文件名字(NdocTest.xml)，如下图：

编译生成的xml文件:

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>NdocTest</name>
    </assembly>
    <members>
        <member name="T:NdocTest.Program">
            <summary>
            测试类
            </summary>
        </member>
        <member name="M:NdocTest.Program.Main(System.String[])">
            <summary>
            程序的入口
            </summary>
        </member>
        <member name="T:NdocTest.Person">
            <summary>
            人
            </summary>
        </member>
        <member name="M:NdocTest.Person.ToString">
            <summary>
            输出姓名和年龄
            </summary>
            <returns></returns>
        </member>
        <member name="P:NdocTest.Person.Name">
            <summary>
            姓名
            </summary>
        </member>
        <member name="P:NdocTest.Person.Age">
            <summary>
            年龄
            </summary>
        </member>
    </members>
</doc>

运行Ndoc,
添加程序集和xml文档

输入要生成的文档类型:
Ndoc支持很多类型,其中包括javadoc和msdn类型.


填入文档输出路径：


生成即可.