57

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

4

5 回答 5

61

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

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

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

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

于 2009-07-17T07:52:44.297 回答
21

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

Doxygen
文档++

于 2009-07-17T02:49:08.950 回答
11

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

于 2009-07-17T02:46:47.720 回答
1

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

于 2012-06-19T06:26:09.073 回答
1

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

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

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

于 2015-09-08T17:20:09.980 回答