Doxygen使用教程（下载链接，配置过程，语法）

目录

Doxygen简介

Doxygen安装

windows环境下安装

Linux环境下安装

1.使用命令安装

2.使用源码安装

安装Graphviz和HTML Help Workshop(可选)

Doxygen配置与操作使用

Wizard配置

Expert配置

Run生成结果

保存工程配置文件

Doxygen语法

---

Doxygen简介

        Doxygen 是一款开源的代码文档生成工具，主要用于从带特定格式注释的源代码中自动提取信息，生成结构化的文档。

        它支持 C、C++、Java、Python 等多种编程语言，可输出 HTML、CHM、LaTeX、PDF 等多种格式的文档，还能自动生成类图、协作图等图表，帮助开发者快速梳理代码结构、理解接口逻辑，是项目文档管理的常用工具。

        使用时，只需在代码中按规范编写注释（如 /** ... */ 格式），通过配置文件（Doxyfile）或图形界面设置参数，即可生成清晰的文档。

Doxygen安装

        Doxygen官方网站，下载软件：https://doxygen.cn/index.html

windows环境下安装

        安装操作步骤安装即可

Linux环境下安装

1.使用命令安装

sudo apt-get install doxygen
sudo apt-get install doxygen-gui

2.使用源码安装

        下载压缩包：如doxyen-1.15.0.src.tar.gz

tar zxvf doxyen-1.15.0.src.tar.gz
cd  doxyen-1.11.0
./configure
make
sudo make install

安装Graphviz和HTML Help Workshop(可选)

        这两个软件是第三方软件，Doxygen 调用该软件可有对应的功能，不是必选的，不过建议安装，可生成CHM帮助手册和代码中各种关系图可自动生成。

Doxygen 调用 HTML Help Workshop 软件 可以生成 CHM 格式的文档
Doxygen 调用 Graphviz 软件可自动生成类图、协作图....关系图

HTML Help Workshop官网：https://www.helpandmanual.com/downloads_mscomp.html
Graphviz官网：https://graphviz.org/
注：记住安装路径，Doxygen配置要用到，否则就无法调用软件生成对应功能文件

Doxygen配置与操作使用

Wizard配置

Expert配置

Run生成结果

保存工程配置文件

Doxygen语法