0、前言
参考帖子。
使用Doxygen Documentation Generator自动添加注释
Doxygen使用教程
代码注释规范之Doxygen
1、Doxygen介绍
Doxygen 是一个功能强大的开源文档生成工具,主要用于从源代码中自动提取注释并生成专业的 API 文档。它支持多种编程语言(C、C++、Java、Python、Objective-C 等),广泛应用于软件开发、库开发和技术文档编写。
- 自动提取代码注释
- 生成多种格式的文档
- 生成类图和依赖关系
- 自动生成文档结构组织
- 条件编译文档(通过 \if、\else、\endif 为不同平台或配置生成不同文档)
2、Doxygen常用注释命令
@project与\project等效,其它注释命令也是一样的道理。
| 注释命令 | 含义 |
|---|---|
| @project | 描述项目 |
| @file | 描述文件 |
| @author | 作者信息 |
| @version | 描述版本 |
| @date | 描述时间 |
| @copyright | 描述权限 |
| @attention | 注意事项 |
| @brief | 概要信息 |
| @example | 使用示例 |
| @ wanrning{warning m |

最低0.47元/天 解锁文章
6400

被折叠的 条评论
为什么被折叠?



