简 述： 在生成的文件html文件可以直接预览到插入的截图图片可以被查看，且手写的注释文档图片也可以被查看

[TOC]


本文初发于 “偕臧的小站“，同步转载于此。


添加注释型图片:

添加的代码注释如下:

/*!
* \~chinese \class QTest
* \~chinese \brief 在此处描述这个类的详细介绍
*
* \~chinese \htmlonly
* <pre style="font-family: FreeMono, Consolas, Menlo, 'Noto Mono', 'Courier New', Courier, monospace;line-height: 100%;">
* 　　　┏┓　　　┏┓
* 　　┏┛┻━━━┛┻┓
* 　　┃　　　　　　　 ┃
* 　　┃　　　━　　　 ┃
* 　　┃　＞　　　＜┃
* 　　┃　　　　　　　 ┃
* 　　┃ . ⌒　..┃
* 　　┃　　　　　　　 ┃
* 　　┗━┓　　　┏━┛
* 　　　　┃　　　┃　Codes are far away from bugs with the animal protecting
* 　　　　┃　　　┃ 神兽保佑,代码无bug
* 　　　　┃　　　┃
* 　　　　┃　　　┃
* 　　　　┃　　　┃
* 　　　　┃　　　┃
* 　　　　┃　　　┗━━━┓
* 　　　　┃　　　　　　　┣┓
* 　　　　┃　　　　　　　┏┛
* 　　　　┗┓┓┏━┳┓┏┛
* 　　　　　┃┫┫　┃┫┫
* 　　　　　┗┻┛　┗┻┛
* </pre>
* \endhtmlonly
* \~chinese 这里什么都不想写.... know, 且和你说, 写代码注释很容易犯困
*/
  • 效果图片

添加真实型图片:

  • 修改Doxyfile文件, 将存放图片的路径添加到IMAGE_PATH = 后面

添加放入图片的路径; 若是存放父路径 “./doc” 也可以; 向下遍历查询到放的图片. 这里的路径是你存放静态图片的路径, 博主为”当前工程项目/doc/images”这个路径

IMAGE_PATH             = ./doc/images
  • 在工程项目里面, 具体的*.cpp 文件里面, 添加符合(doxygen)规范的注释, 便于生成

实际用法:

cd doc/image
用法: image htmp 图片.png

eg:

/*!
 * \~chinese \class QTest
 * \~chinese \brief 这是一个演示的类的详细描述
 * \chiinese \image html gril.png
 */
  • 然后执行生成文件即可, 查看预览效果