44

我想在 C++ 中尝试一个新项目的文档生成器。我认为我的选择是 Doxygen 或 Sphinx。由于我在 Python 中有想要使用 Sphinx 的项目,我想知道 Sphinx 是否也是 C++ 的正确选择。Sphinx网站声明支持 C++,但我找不到让我开始使用 C++ 文档的文档。

Stackoverflow 上已经讨论了一个类似的问题,主要答案得出结论:

尚未完全可用,
但请继续关注

由于讨论已经有一年多了,我想知道这个结论是否仍然有效。我应该为我的 C++ 文档选择 Doxygen 而不是 Sphinx 吗?

4

2 回答 2

25

Sphinx 不能单独从 C++ 源代码中提取文档。但是,有一些扩展,最显着的是Breathe,它利用 Doxygen 从 C++ 中提取文档。我没有测试过这些。

于 2012-10-18T12:05:35.467 回答
0

对于 C++ Doxygen 非常好;C++ 的 Sphinx 支持是通过 Doxygen 完成的(使用Breathe)。

您希望两种语言只有一个工具,以提高可维护性。Doxygen 可以从 Python 代码生成文档,因此我建议您尽可能将 Doxygen 用于这两个源。这是 Doxygen 和 Python 的教程

于 2012-10-17T14:27:18.060 回答