用Sandcastle一键生成CHM帮助文档

NDoc是一个很好的工具,可以把.net中的注释导出,生成chm文档一边查阅和管理。可惜因为没有得到开源社区的支持已经停止开发。

Sandcastle原本是微软内部用于开发管理的一个工具,它的功能和NDoc基本一致。由于它能够得到微软的支持,所以更新和维护基本不用担心。

但Sandcastle目前还不够完善,至少有两点不足:

1、目前只能通过doc命令执行,没有GUI;

2、目前只支持单个工程,不能合并处理整个解决方案。

微软承诺以后的版本会做功能升级和完善,但何时能够完成并没有时间表。

针对这两点不足,已经有人做了很好的GUI软件,以满足人们需求。但仍然会有一些缺陷无法很好满足。

实际上,最新的Sandcastle版本内部包含的一个bat文件,已经把十几个步骤的doc命令进行了集成,使得用户只要一个doc命令就可以完成整个doc命令集操作。

实现方法如下:

1、下载并默认安装HTML Help Workshop和Sandcastle;

2、新建一个空目录(如:example),把需要处理的工程的dll文件和包含注释信息的工程XML文件拷贝到这个目录下(如:这个工程为test,则,这两个文件分别是:test.dll和test.xml);

3、到“C:\Program Files\Sandcastle\Examples\sandcastle”目录下拷贝“build_Sandcastle.bat”文件到example目录下;

4、打开cmd窗口,转到example目录下,执行如下命令:build_Sandcastle vs2005 text;

5、几分钟之后,执行完毕你可以在chm目录下看到test.chm文档。

posted on 2008-01-08 16:59  Gofficer  阅读(673)  评论(0)    收藏  举报