Sphinx是否已经适合C ++文档?

时间:2012-10-17 12:03:26

标签: c++ documentation doxygen python-sphinx

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

类似的问题已经discussed on Stackoverflow,主要答案是:

  

尚未完全使用,
     但继续看

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

2 个答案:

答案 0 :(得分:20)

Sphinx无法从C ++中提取文档。但是,有一些扩展,最值得注意的是Breathe,它们利用Doxygen从C ++中提取文档。我没有测试过这些。

答案 1 :(得分:0)

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

您希望只有一种工具用于这两种语言,以提高可维护性。 Doxygen can generate a documentation from Python code ,所以我建议您尽可能使用Doxygen作为两种来源。 Here is a tutorial for Doxygen and Python