学习使用doxygen生成代码的文档

目标

doxygen 可以用来为代码生成文档（需要代码本身有符合格式的注释）。
可以看到Houdini的HAPI文档就是用它生成的：

本篇的目标是尝试学习使用它，对一个简单的代码源文件生成文档。

（关于doxygen的入门级知识，可参见上一篇翻译《Doxygen 手册：入门》）

0. 安装Doxygen

官方文档中有关于 UNIX / Windows 上以 源代码编译 / 二进制安装包 来安装的介绍。
不过对于入门来说可能不需要看那么细，直接在官网下载页面中下载Windows版二进制安装包即可：

打开安装包运行即可

1. 准备测试用的源代码文件

正常流程来讲，源代码需要在编写的时候就有符合格式的注释。这里因为是测试，我就直接使用虚幻引擎的源代码作为测试了，因为它也是符合格式要求的。
我将 \Engine\Source\Editor\UnrealEd\Public\FileHelpers.h 拷贝到测试目录 D:\Test\Test0820 中。

2. 使用 doxywizard 生成文档

正如 前一篇所说，doxywizard 是对 核心doxygen 的图形界面封装，因此使用它会更加方便。

可以在安装目录的 bin 文件夹找到它：

启动它后，选择上一步中建立的测试目录：

然后，在 run 分栏点击 Run doxygen按钮：

等待执行完成：

现在，就可以在测试目录看到生成的文档了：

3. 结果

HTML文档可以从目录 html/index.html 进入：