Doxygen下载安装使用教程(附安装包)
Doxygen 是一款“代码文档自动生产机”,只要你提前在源代码里用规定格式写好注释,Doxygen 就能把注释连同函数、类、变量之间的调用关系一起抽出来,自动生成网页、PDF、Word、CHM 等多种格式的技术文档。
Doxygen 支持多种编程语言,包括 C/C++、C#、Java、Python、PHP、Objective-C、IDL、VHDL、Fortran 等。Doxygen 可以生成 HTML(在线浏览)、LaTeX(可转 PDF)、RTF(Word 可读)、CHM(离线帮助)、XML(可被其它工具二次消费)。
下面罗列了 Doxygen 的一些实际应用场景:
一句话总结,写一次注释,Doxygen 就能帮我们生成一份随时在线、可搜索、带超链接的“程序员百科全书”,再也不用手动敲 Word 了。
2) 如果是 Mac OS 平台,从网盘下载名为“Doxygen-1.14.0.dmg”的安装包,直接把他拖到 application 上面就可以了。
3) 如果是 Windows 平台,从网盘下载名为“doxygen-1.14.0-setup.exe”的可执行程序,然后傻瓜式一步一步安装就可以了。安装完成后在开始栏点击 Doxywizard 就可以打开软件了。
下载 Graphviz 的地址为:
网盘中是 Windows 平台的 Graphviz 安装包,如果是 Linux 平台,可以执行如下命令下载 Graphviz:
如果是 Mac OS,可以执行如下命令下载 Graphviz:
假设工作目录如下:
其中 math.h 代码如下:
Doxygen 生成的 HTML 会放到 out 目录下,生成的 HTML 如下图所示:
Doxygen 支持多种编程语言,包括 C/C++、C#、Java、Python、PHP、Objective-C、IDL、VHDL、Fortran 等。Doxygen 可以生成 HTML(在线浏览)、LaTeX(可转 PDF)、RTF(Word 可读)、CHM(离线帮助)、XML(可被其它工具二次消费)。
下面罗列了 Doxygen 的一些实际应用场景:
- 开源库:GitHub 上的 README 常贴一行“[Online Docs]”,背后就是 Doxygen 生成的静态页。
- 团队接口文档:后端把 .h 文件注释写好,前端点网页即可看函数说明,零沟通成本。
- 毕业设计/大作业:老师要求“交纸质技术文档”,运行 Doxygen → 导出 PDF,页码自动编,目录自动生。
- 老项目维护:百万行代码无文档?先让 Doxygen 跑一遍,自动生成调用关系图,快速定位“上帝类”。
一句话总结,写一次注释,Doxygen 就能帮我们生成一份随时在线、可搜索、带超链接的“程序员百科全书”,再也不用手动敲 Word 了。
下载Doxygen
这里给大家提供了 Doxygen 的最新版安装包,下载地址为:网盘中为大家准备好了 Windows、Linux 和 Mac OS 这 3 种平台的安装包。
安装Doxygen
1) 如果是 Linux 平台,执行如下命令可以安装 Doxygen:再执行sudo apt-get install doxygen
sudo apt-get install doxygen-gui
安装 gui,就可以像 windows 那样使用图形化操作了,图形界面可以通过 doxywizard 命令运行。2) 如果是 Mac OS 平台,从网盘下载名为“Doxygen-1.14.0.dmg”的安装包,直接把他拖到 application 上面就可以了。
3) 如果是 Windows 平台,从网盘下载名为“doxygen-1.14.0-setup.exe”的可执行程序,然后傻瓜式一步一步安装就可以了。安装完成后在开始栏点击 Doxywizard 就可以打开软件了。
下载Graphviz(可选)
Graphviz 是 Doxygen 用于自动生成类图的工具。Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图,如不需要此功能可不安装该工具包。下载 Graphviz 的地址为:
网盘下载:https://pan.quark.cn/s/7cc60e25112c
网盘中是 Windows 平台的 Graphviz 安装包,如果是 Linux 平台,可以执行如下命令下载 Graphviz:
sudo apt install graphviz // Debian、Ubuntu
sudo dnf install graphviz // Fedora、Rocky Linux、Redhat Enterprise Linux、CentOS
如果是 Mac OS,可以执行如下命令下载 Graphviz:
sudo port install graphviz
或者:brew install graphviz
使用Doxygen
图形工具的基本使用如下图所示,有非常多的配置选项,这里我们只填入必要的配置,其它配置都用默认值。

假设工作目录如下:
. ├── out └── src └── math.h
其中 math.h 代码如下:
/*! \file math.h */ /*! 用于求一个角度的sin值,输入是字符串以便同时支持弧度制和角度制表示 \li 弧度制用pi表示,例如:2pi表示一圈、0.5pi表示直角 \li 角度制用d结尾,例如:360d表示一圈、90d表示直角 \li 输入也可以是数值,例如:输入3.14159大约表示180度 \param a 用弧度制或角度制表示都行,字符串必须用'\0'表示结束 \param[out] res 是输出参数,用于保存sin运算的结果 \return 错误码,0表示成功,其它表示失败 \todo 在xxx的情况下存在BUG,预计下一版本修复 */ int sin(char *a, double *res);
Doxygen 生成的 HTML 会放到 out 目录下,生成的 HTML 如下图所示:
