类似于Javadoc的C ++文档

Question

对于C ++，是否有像Javadoc这样的文档生成系统？ Javadoc产生了很好的输出;如果你能在其他语言中使用类似的东西，那就太棒了。

Answer 1

有几种工具可以像JavaDoc for C ++一样工作最流行的工具可能是doxygen。它可以处理类似JavaDoc的注释，还可以处理多种语言（例如，C ++，C，Java，Objective-C，Python，PHP，C＃）。它非常适合使用CSS调整HTML输出的样式（请参阅users list示例文档）。

选择文档系统时的两个重要问题是确保它允许您

• 记录您感兴趣的实体。是否要按照代码结构或某些其他模块部门记录系统。
• 根据需要格式化输出。当文档符合您的一般项目风格时，这是最好的。

我们使用doxygen的经验是它很容易设置和使用，结果输出很容易调整。不幸的是，doxygen并不完美，所以在某些情况下，有必要解决doxygen解析器发生故障的怪癖或错误。请务必仔细检查所有生成的文档。

Answer 2

您无法专门使用javadoc，但有一些工具可以满足您的需求。大多数人倾向于使用的是Doxygen。以下是Doxygen和Doc ++的一些链接：

Doxygen
Doc++

Answer 3

doxygen支持很多事情（以及更多）Doxygen

Answer 4

基于QT的C ++项目也有qdoc。 http://doc-snapshot.qt-project.org/qdoc

Answer 5

我刚刚开始在我的Python项目中使用Sphinx。它的主页声明“C / C ++也已得到支持”。

它使用名为“reStructuredText”的轻量级标记。

我刚刚开始将它用于我的Python项目，并且非常喜欢输出的外观。