【转】windows环境下利用doxygen生成代码文档

作者：jiangwenna    http://www.jiangwenna.com/windows-doxygen-doc/

Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器（或.chm格式），或离线的LATEX、RTF参考手册。

准备工作：

1、下载最新版本的doxygen（当前使用1.7.6）

2、下载Graphviz,当前使用版本2.28。Graphviz是一个图形可视化软件。Doxygen使用Graphviz生成各种图形，例如类的继承关系图。Doxygen使用了Graphviz的布局引擎dot。

3、html help workshop。该软件利用html文件生成.chm格式的文件，一般windows中可能已经安装

配置：





在wizard菜单下，对于“project”标签，设置对应的doxygen的工作路径、源代码的路径、生成的doc的路径、软件的版本号等，可以将工程src目录拷贝到单独的文件夹下。





在wizard菜单下，对于“output”标签,设置生成文件的格式为.chm





在wizard菜单下，对于“diagram”标签,生成我们需要的框图





在expert菜单下，对于于“project”标签,设置输出语言为Chinese,输出文件的编码为UTF-8





在expert菜单下，对于“input”标签下，设置输入文件的编码为UTF-8，当然源代码对应的编码格式也为UTF-8





在expert菜单下，对于“HTML”标签下，勾选’GENNERATE_HTMLHELP’,并且设置生成的.chm文件的名称，此时就需要使用“html help workshop”软件的hhc.exe，在“HHC_LOCATION”下输入hhc.exe文件的路径，通常情况下为“C:\Program Files\HTML Help Workshop”。最重要的一点在“CHM_INDEX_ENCODING”栏中，输入GB2312，此项的作用是使得生成的.chm文件目录不存在中文乱码。

最后，在run菜单下，即可开始文档的生成