c++ - 在 Visual Studio 2008 项目中使用 Doxygen

Question

我想为我的解决方案中的一个项目安装和创建 Doxygen HTML 文档。能否请您一步一步地告诉过程。我用谷歌搜索并没有找到这样的信息。

编辑：它可以集成到 Visual Studio 2008 中吗？

Answer 1

您是否尝试过 Doxygen 文档？:) http://www.doxygen.nl/manual

我要做的是完成安装项目并制作一些样板示例，这些示例仅概述您正在创建的方法。从小处着手。

编辑：刚刚看到您关于使用 VS 2008 的帖子。虽然我没有尝试使用该特定版本的 Doxygen，但我怀疑这应该是可能的，因为您只是用 Doxygen 识别的标签标记您的评论

Answer 2

我已经从http://www.doxygen.nl/download.html下载了 doxygen doxygen-1.8.2-setup.exe并安装了它。然后运行它，给出我需要文档的项目目录和一些其他选项。就是这样！

Answer 3

您首先需要确保 doxygen 已安装并可在系统路径上访问。您可能还想安装 graphviz (dot) 以绘制图形。

接下来，运行：

doxygen -g MyProject.doxyconf

这会生成一个 doxygen 配置文件。编辑此文件以对其进行自定义。它包含描述选项作用的注释，因此请相应地设置它们。

您现在可以使用以下命令生成 doxygen 文档：

doxygen MyProject.doxyconf

要将其与 Visual Studio 集成，请创建一个新的 makefile 项目（例如 MyProject.documentation）。然后可以将其配置为运行以下命令：

Build   : doxygen MyProject.doxyconf
ReBuild : doxygen MyProject.doxyconf
Clean   : cd $(ProjectDir)/docs && del /s *.*

注意：我不确定是否$(ProjectDir)正确，但您仍然需要更改$(ProjectDir)/docs到生成文档的位置。

然后，您可以根据需要将文档添加到项目中。我对此的建议是迭代地进行。从一个区域（标题/类）开始，查看 doxygen 产生的输出，然后逐步改进它。

http://www.doxygen.nl/manual/docblocks.html展示了添加 doxygen 文档的基础知识。

http://www.doxygen.nl/manual/commands.html提供了 doxygen 注释中可用的所有可用命令的参考。

http://www.doxygen.nl/manual提供了额外的文档。