轻松生成中文 CHM 文档:Doxygen 1.8.8 图文教程

想用 Doxygen 生成全中文的 CHM 文档?这篇教程手把手教你!

一、项目设置

  1. 打开 Doxygen,在“Wizard”标签的“Project”项中设置项目名称和源码目录。
  2. 如果要包含所有子目录,记得勾选“递归扫描”。
  3. 设置好输出目录,建议使用相对路径。
  4. 在“Mode”项设置文档生成模式,然后在“Output”项勾选“HTML”和“prepare for compressed HTML chm”。

二、HTML 和 CHM 选项

  1. 切换到“Expert”标签的“HTML”项。
  2. 确保勾选了“GENERATE HTMLHELP”。
  3. 在“CHM FILE”中设置 CHM 文件名,例如“MyDoc.chm”。
  4. 在“HHC LOCATION”中指定 CHM 编译器(hhc.exe)的全路径。
  5. 在“CHM INDEX ENCODING”中设置为“GBK”编码,避免乱码。

三、高级设置

  1. 在“Expert”标签中找到以下重要设置项:
    • Project DOXYFILE ENCODING: Doxygen 配置文件的编码,默认为 UTF-8。
    • Project OUTPUT LANGUAGE: Doxygen 生成文本的语言,选择“Chinese”。
    • Input INPUT ENCODING: 源代码文件的编码,Windows 平台一般为 GBK,Linux 平台一般为 UTF-8。
    • HTMP CHM INDEX ENCODING: Doxygen 生成的 CHM 索引编码,设置为“GBK”。
  2. 仔细检查所有编码设置,确保一致性,避免乱码。

通过以上步骤,就能轻松生成全中文的 CHM 文档啦!

7z 文件大小:7.59MB