Doxygen最初是一个C++的源码文档生成成器,现在也支持像C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl等语言,可以方便生成源码文档,配合Graphviz可以清晰地生成函数和类的对应关系图,对于阅读源码结构有很大帮助
下载
Graphviz
是一个由AT&T实验室启动的开源工具包,用于绘制DOT语言脚本描述的图形,用于绘制源码中的UML图。
Doxygen
进入官网下载,这里是以Windows系统为例,其他系统官网也有详细的下载安装介绍,官网也有相应的使用文档,很齐全
htmlhelp
hemlhelp是为了生成chm文件用的,进入官网后点击DOWNLOAD后会有个弹框,点击中间的Softpedia Mirror(US)
然后再等一下下就会弹出下载了
安装
安装流程按以下顺序,这里是Windows系统,所以安装过程一路next便行。
- Graphviz
- Doxygen
- htmlhelp
配置
进入安装的Doxygen目录,再进入bin
目录,打开里面的doxywizard.exe
即运行Doxygen。
随后按以下图进行配置,我这里以Leveldb
源代码为例
这里可以点击save
来保存配置文件,方便以后使用