Doxygen使用教程
Doxygen 可以用来为项目生成帮助文档或者 SDK,输出格式可以为 HTML、CHM 等。
1 软件安装
- doxygen-1.9.1-setup.exe
- stable_windows_10_cmake_Release_x64_graphviz-install-2.47.3-win64.exe
- htmlhelp.exe
2 Doxygen 注释规范
2.1 注释格式
1 | # 块注释 |
注释命令 | 描述 |
---|---|
@brief | 概要信息 |
@details | 详细描述 |
@par | 开始一个段落,段名自定义 |
@param | 标记参数意义 |
@return | 描述返回意义 |
@retval | 描述返回值意义 |
@todo | 对将要做的事情进行注释 |
@bug | 缺陷,链接到所有缺陷汇总的缺陷列表 |
@since | 通常用来说明从什么版本、时间写此部分代码 |
@pre | 用来说明代码项的前提条件 |
@post | 用来说明代码项之后的使用条件 |
@code | 在注释中开始说明一段代码,直到@endcode命令 |
@endcode | 注释中代码段的结束 |
@fn | 函数说明 |
@include | 包含文件 |
@var | 标注变量 |
@enum | 标注枚举 |
@struct | 标注结构体 |
@class | 标注类 |
@note | 描述一些注意事项 |
@addtogroup | 添加到一个组 |
2.2 自动注释模板(VSCode settings.json 配置)
1 | { |
2.3 手动注释模板
2.3.1 文件注释模板
1 | /** |
2.3.2 函数注释模板
1 | /** |
3 使用教程
3.1 Doxygen Wizard Project
3.2 Doxygen Wizard Mode
3.3 Doxygen Wizard Output
3.4 Doxygen Wizard Diagrams
3.5 Doxygen Expert Project
3.6 Doxygen Expert HTML
3.7 Doxygen Expert Dot
4 生成效果
HTML 网页效果
CHM 文档效果
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 云!
评论