类似 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 解析器崩溃的怪癖或错误。请务必仔细检查您生成的所有文档。