类似 Javadoc 的 C++ 文档答案

【问题标题】：Javadoc-like Documentation for C++类似 Javadoc 的 C++ 文档
【发布时间】：2009-07-17 02:44:53
【问题描述】：

是否有类似的 C++ 文档生成系统，如 Javadoc？ Javadoc 产生很好的输出；如果您可以在其他语言中使用类似的东西，那就太好了。

【问题讨论】：

【解决方案1】：

有几个工具可以像 JavaDoc for C++ 一样工作。最流行的工具可能是doxygen。它可以处理类似 JavaDoc 的 cmets，也可以处理多种语言（例如，C++、C、Java、Objective-C、Python、PHP、C#）。它对使用 CSS 调整 HTML 输出的样式有很好的支持（参见 users list 示例文档）。

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

记录您感兴趣的实体。您是要按照代码结构还是按照其他模块划分来记录系统。
根据需要格式化输出。当文档适合您的一般项目风格时，它会更好。

我们使用 doxygen 的经验是，它非常容易设置和使用，并且生成的输出也很容易调整。不幸的是，doxygen 并不完美，因此在某些情况下，有必要解决 doxygen 解析器崩溃的怪癖或错误。请务必仔细检查您生成的所有文档。

【讨论】：

关于解析器故障，我发现自从使用 XML 注释后，我的问题似乎得到了解决，但同样没有多少可用的编辑器和 IDE 支持开箱即用。

【解决方案2】：

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

Doxygen
Doc++

【讨论】：

Doxygen 效果很好，被用于大量项目中。

【解决方案3】：

doxygen 支持很多东西（以及更多）Doxygen

【讨论】：

【解决方案4】：

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

【讨论】：

【解决方案5】：

我刚刚开始在我的 Python 项目中使用 Sphinx。它的主页上写着“C/C++ 也已经被支持”。

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

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

【讨论】：