使用Doxygen软件将程序代码自动生成chm格式帮助文档

时间:2024-03-26 11:43:15

Doxygen生成chm帮助文档

代码帮助文档可以给程序开发、理解、维护、扩展带来质的提升!


前期准备

  • 下载和安装Doxygen软件
  • 下载和安装 微软chm编译器
  • 可选下载和安装Graphviz图形绘制软件
    该软件可用来生成代码文档和函数等之间的引用调用关系图。
  • 基于doxygen注释规范的程序代码
    doxygen注释规范可以参考其自带帮助文档doxygen_manual.chm(安装完Doxygen软件后在其安装目录下),或者参考相关博客

Doxygen软件参数配置(C++为例)

  1. 运行Doxywizard,软件界面如下图:
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  2. Wizard->Project页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  3. Wizard->Mode页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  4. Wizard->OutPut页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  5. Wizard->Diagrams页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  6. Expert->Project页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  7. Expert->Build页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  8. Expert->Input页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  9. Expert->Source Browser页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  10. Expert->HTML页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  11. Expert->Dot页按下图设置参数。
    使用Doxygen软件将程序代码自动生成chm格式帮助文档

  12. 点击Run->Run doxygen生成帮助文档,可以到初始设置的生成目录下查看.chm文件。


常见问题解决方案

  1. Error: failed to translate characters from GB2312 to UTF-8
    可能原因:
    • 代码输入路径或者文档输出路径存在中文路径
    • 输入代码编码格式为GB2312,但Doxygen在配置参数Input时设置为UTF-8
  2. 中文注释都是乱码
    检查程序配置参数中涉及的编码格式,看是否符合输入输出。