使用Doxygen for Visual Studio 2008项目[关闭]

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（点）。

接下来，运行：

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注释中可用的所有可用命令的参考。