记录下vs2008中Doxygen的配置。参考了两篇文章:文章一,文章二。主要方便自己以后能尽快上手。
首先在网上下载Doxygen,HTML Help Workshop。这两个软件直接在各自的官网上下载就行了。
然后使用doxywizard.exe生成一个Doxygen文件。点击“D:\program files\Doxygen\doxygen\bin\doxywizard.exe”出现如下界面:在Wizard属性页主要需要改一个地方,点击左侧的“Output”将右侧复选框中的LaTex中的钩去掉;然后在Step1:下面指定Doxygen的工作目录,就是这个向导生成的文件的存放路径。
在"Wizard"和“Export”中还有许多可以编辑的参数,暂时不修改,以后熟悉了再改。然后点击“Run”下面的“Run doxygen”就可以生成了脚本。
再点击“File”菜单中的"Save as",就可以生成我们需要的脚本了,将生成的脚本命名为default.doxygen如图:
default.doxygen就是普通的文本文件,在这里需要对它进行一些编辑,这些需要编辑的地方主要是字符编码的问题,其实在前面的图形化界面中也可以进行更改的。
主要需要修改的地方有如下几处:
GENERATE_HTMLHELP = YES
OUTPUT_LANGUAGE = Chinese
CHM_INDEX_ENCODING = gb2312DOXYFILE_ENCODING=gb2312
INPUT_ENCODING=gb2312
然后这个default.doxygen就处理好了。
接下来是在vs中集成这些工具方便以后使用了。将default.doxygen拷贝到需要生成文档的工程下面。
1.集成Doxygen
在VS环境中:Tools->External Tools->Add
Title: Doxygen
Command: D:\Program Files\doxygen\bin\doxygen.exe(doxygen的安装目录)
Arguments: $(ProjectDir)\default.doxygen
Initial directory: $(ProjectDir)
(可以把use output window复选框勾上)
点击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\Doxygen\htmlhelp\hhw.exe(HHW的安装目录)
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.exe(windows自带)
Arguments: $(ProjectDir)html\index.chm
Initial directory:
点击Tools-> ViewCHM,就会看到index.chm文件了。