一文学会如何使用Doxygen生成你的C++项目API文档

本文详细介绍Doxygen的安装配置及使用方法,包括代码注释规范、生成文档流程及样式定制,适合C++等语言项目自动生成API文档。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

基本介绍

参考:http://guqian110.github.io/pages/2015/01/11/how_to_analyse_code_elegantly.html
系统介绍:
https://blog.mythsman.com/post/5d29efa3cc343d1901c61cb3/
https://www.cnblogs.com/liuyunbin/p/11553583.html

Doxygen是API文档生成工具,可以根据代码注释生成代码文档,列出程序中的变量、类定义、数据结构、函数表用关系

先安装graphviz,再安装Doxygen:
sudo apt install graphviz
sudo apt install doxygen
sudo apt install doxygen-gui
生成配置文件:默认配置文件名为Doxyfile
doxygen -g
doxygen -s -g  #不含注释的配置文件

代码注释指南:

https://blog.youkuaiyun.com/wenrenhua08/article/details/39591239
https://blog.youkuaiyun.com/czyt1988/article/details/8901191
https://www.cnblogs.com/liuyunbin/p/11553583.html
https://greedyhao.cc/2017/08/10/%E5%B7%A5%E4%BD%9C-doxygen-2017-08-10-Using-doxygen/
https://www.jianshu.com/p/0d3fa90ebddf

注释风格:http://blog.guorongfei.com/2016/11/20/doxygen-usage/

1、源码文件描述:

/**
 * @file
 * @brief Series of cout/print utilities for debug
 */

生成文档样式:
2、类的描述

3

Doxygen生成文档流程:

基本生成模板:
生成函数调用流程图:https://www.jianshu.com/p/fe4b6b95dca5
比较全的调用图:http://www.360doc.com/content/12/0812/14/7851074_229747305.shtml

可以使用可视化界面进行配置:
运行:
doxywizard
界面详细介绍:https://blog.youkuaiyun.com/hzt12345hf/article/details/50738395
https://www.jianshu.com/p/bf5afbbe183b
https://zhuanlan.zhihu.com/p/100223113
https://marlous.github.io/2019/02/02/%E4%BD%BF%E7%94%A8-Doxygen-%E8%87%AA%E5%8A%A8%E7%94%9F%E6%88%90%E4%BB%A3%E7%A0%81%E6%96%87%E6%A1%A3/
https://www.cnblogs.com/tianzhijiexian/p/4392924.html

生成chm文档:https://blog.youkuaiyun.com/hzt12345hf/article/details/50738395
https://blog.youkuaiyun.com/xzytl60937234/article/details/70448102

生成的要素总结:
文件包含关系图:

文件被包含结构图:

函数的call graph:
类的Collaboration diagram(UML中的协作图):
类的Inheritance diagram(继承图):
目录依赖关系图:

问题:

Q1:如何去掉生成文档中的绝对路径,改为使用相对路径?
Q2:Main Page如何设置?
Q3:@class怎么使用?
Q4:C++项目中包含了python代码,也解析了Python,如何不解析Python

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值