doxygen chm

### 如何使用 Doxygen 生成 CHM 文件 Doxygen 是一种强大的自动化文档生成工具，支持多种输出格式，其中包括 HTMLHelp (CHM) 文件。以下是有关如何配置和生成 CHM 文件的具体方法： #### 配置 Doxygen 支持 CHM 输出 为了使 Doxygen 能够生成 CHM 文件，需要在 `Doxyfile` 中启用特定选项并设置相关参数。 1. **启用 HTML 输出** 确保启用了 HTML 输出功能，因为 CHM 文件本质上是一个压缩的 HTML 文档集合。 ```plaintext GENERATE_HTML = YES ``` 2. **指定 HTML Help 工具链** 启用 HTML Help 功能，并提供 Microsoft HTML Help Workshop 的路径（如果未自动检测到）。HTML Help Workshop 是生成 CHM 文件所需的工具集。 ```plaintext GENERATE_HTMLHELP = YES CHM_FILE = output.chm HHC_LOCATION = C:/Program\ Files/HTML\ Help\ Workshop/hhc.exe ``` 上述配置中的 `HHC_LOCATION` 应指向本地安装的 HTML Help Compiler (`hhc.exe`) 所在位置[^3]。 3. **定义索引和目录结构** 使用以下选项来控制 CHM 文件的内容树和索引行为： ```plaintext BINARY_TOC = YES # 创建二进制表 of contents (TOC)，这可以提高加载速度。 TOC_EXPAND = YES # 展开 TOC 树以便于导航。 CREATE_SUBDIRS = NO # 不创建子目录以简化文件管理。 CONTENTS_FILENAME = index.hhp # 定义 .hhp 文件名作为输入给 hhc.exe。 ``` 4. **运行 Doxygen 和编译器** - 运行 Doxygen 处理源码并生成中间 HTML 文件以及 `.hhp` 描述文件。 - 利用 HTML Help Compiler 将这些文件打包成最终的 CHM 文件。 如果是在 Windows 平台上操作，则可以通过命令行完成此过程： ```cmd doxygen Doxyfile hhc index.hhp ``` 5. **跨平台注意事项** 对于 Linux 或 macOS 用户来说，由于缺少原生的 HTML Help Workshop，可能需要借助 Wine 来模拟执行环境或者考虑其他替代方案如 ezipchm[^1]。 #### 示例代码片段展示 Doxyfile 设置部分 ```makefile # 开启必要的开关 GENERATE_HTML = YES GENERATE_HTMLHELP = YES BINARY_TOC = YES EXTRACT_ALL = YES # 指定帮助编译器的位置(仅限Windows) HHC_LOCATION = /path/to/htmlhelp/hhc.exe # 自定义输出名称 PROJECT_NAME = MyProject OUTPUT_DIRECTORY = docs/ CHM_FILE = myproject.chm CONTENTS_FILENAME = myproject_contents.hhc INDEX_FILENAME = myproject_index.hhk ``` #### 常见问题排查 - 若遇到错误提示找不到某些资源，请确认所有依赖项均已正确定位。 - 当发现生成后的 CHM 文件无法打开时，可能是内部链接损坏所致；尝试重新验证项目的注解是否遵循标准[^2]。