由于在完成编码后,需要生成帮助文档,以下内容讲述了如何在不离开VS.NET开发环境的情况下来完成文档的生成与查看。

软件环境VS2005,Doxygen

1.集成Doxygen

VS环境中:Tools->External Tools->Add

Title: Doxygen

Command: D:\Program Files\doxygen\bin\doxygen.exedoxygen的安装目录)

Arguments: $(ProjectDir)\default.doxygen

Initial directory: $(ProjectDir)

注意default.doxygen需要自己用doxywizard生成,然后进行适当修改:

OUTPUT_DIRECTORY这行要屏蔽

INPUT这行要屏蔽

GENERATE_HTMLHELP      = YES

OUTPUT_LANGUAGE        = Chinese

(可以把use output window复选框勾上)

而且,需要把default.doxygen拷贝到工程目录下。

点击Tools->Doxygen,将会在工程目录下生成html文件夹,里面的html文件就是自动生成的注释文件。

2.集成CHM制作工具HTML Help Workshop

首先安装HTML Help Workshop,附件中有提供。

VS环境中:Tools->External Tools->Add

Title: HTML Help Workshop

Command: D:\Program Files\HTML Help Workshop\hhw.exeHHW的安装目录)

Arguments: $(ProjectDir)html\index.hhp

Initial directory: $(ProjectDir)

点击Tools->HTML Help Workshop,就会出现HHW的窗体,编译,可得到index.chm文件。

注意:编译时,会弹出一个窗口确认路径名,而VS自动传入的路径名是有错误的,多了2个双引号,去掉双引号,编译,就可以成功了。

 3.集成CHM文件查看工具hh.exe

VS环境中:Tools->External Tools->Add

Title: ViewCHM

Command: C:\WINDOWS\hh.exewindows自带)

Arguments: $(ProjectDir)html\index.chm

Initial directory:

点击Tools-> ViewCHM,就会看到index.chm文件了。