Doxygen可以为多种语言生成说明文档(从程序的源代码中提取其中按照约定格式写的注释中提取信息)
例如C++, Objective-C, C#, C, PHP, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, D ,从这期开始,我将系统地介绍Doxygen的使用,包括以下内容:
- Doxygen安装和配置
- DOxygen for C++使用说明——注释代码一
- DOxygen for C++使用说明——注释代码二
- DOxygen for C++使用说明——添加数学公式
- DOxygen for C++使用说明——Markdown支持
安装
doxygen安装
我们可以从doxygen官网上下载最新的doxygen软件,我的是doxygen-1.8.10,然后一路next下去即可。
Graphviz 安装
Graphviz是大名鼎鼎的贝尔实验室的几位牛人开发的一个画图工具。
它的理念和一般的“所见即所得”的画图工具不一样,是“所想即所得”。
Graphviz提供了dot语言来编写绘图脚本。在doxygen中我们可以使用Graphviz绘制函数调用图、类的继承关系图等各种各样的图。
首先先在Graphviz 主页下载,如下图:
选择图中圈起的版本,然后一路安装,
注意:一定要记住Graphviz的安装目录,以后还会用得着。
HHC.exe安装
使用Doxygen可以生成多种形式的文件,这里我们选择生成compressed html(即CHM格式文档)与latex格式的(即PDF格式文档),
生成chm文件,需要用到MS HTML Help Compiler,为此我们在HTML Help (CHM) Help Compiler官网下载hhc.exe,然后一路安装即可。
注意:一定也要记住hhc.exe的安装目录,以后还会用得着。
配置
首先先给个福利,此链接是我已经配置好的,可以直接使用。
使用方法是:选择【开始】菜单,打开Doxygen文件夹,选择Doxywizard程序,然后就出现了以下界面,点击【File】,选择【open】,然后:
下面介绍具体的配置方法:
然后
并且我们可以点击【File】的【Save】保存配置,下一次就可以直接使用了。
参考文献
- DoxyGEN 的使用与Graphviz 的使用
- 用Doxygen Graphviz生成函数调用流程图
- 强大的Doxygen工具使用手册
- Doxygen + Graphviz windows下安装配置(图解)