Ubuntu下的Doxygen+VScode实现C/C++接口文档自动生成

Ubuntu下的Doxygen+VScode实现C/C++接口文档自动生成

1、 Doxygen简介

Doxygen 是一个由 C++ 编写的、开源的、跨平台的文档生成系统。最初主要用于生成 C++ 库的 API 文档，但目前又添加了对 C、C#、Java、Python、Fortran、PHP 等语言的支持。其从源代码中提取注释，并生成多种输出格式，如HTML、PDF、LaTeX、RTF等，以帮助开发者创建易于阅读和理解的代码文档。

Doxygen 简化了另行编写文档带来的重复性劳动，将代码和文档的工作合二为一。经过 10 年的迭代，Doxygen 成为了 C/C++ 项目首选的文档生成工具。

官网地址：https://www.doxygen.nl/

1、安装Doxygen

1）方法一：
ubuntu下apt命令快速安装

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

注意，如需在html的文档，中显示类图等关系图，需要安装graphviz库，安装命令如下
sudo apt-get install graphviz
且需要在Doxyfile配置文件中的DOT_PATH 指定graphviz的命令行路径

验证查看一下版本：

$ doxygen --version
1.9.1

2）方法二：
采用源码编译，则需要先下载源码，源码下载地址，点这里

执行如下命令

cd doxygen-1.12.0
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=~/DOXYGEN ..  # 指定安装doxygen的用户目录为~/DOXYGEN
make
make install

添加到环境变量中

vim .bashrc
export PATH=$HOME/DOXYGEN/bin: