结合 Docbook 和 Doxygen 文档类型。

Question

我正在为我们的软件库编写新文档，我想知道如何将我认为应该用 DocBook 编写的通用文档与基于 Doxygen 的 API 引用结合起来。

Doxygen 部分已经存在，所以我更愿意保留它，但使用 DocBook 只是一个想法，我愿意接受任何想法。用 Doxygen 编写整个文档是可能的，但在我看来这不是最好的方法。

谢谢!

Answer 1

我建议您重新考虑采用全 Doxygen 方式。尽管使用 Doxygen 编写详尽的文档一开始可能看起来很麻烦，但从长远来看，保持两个文档的一致性将是更多的工作。除了通过组合两者的输出产品而增加的工作量之外。

Doxygen 可以将 Markdown 文件作为页面包含到您的文档中(请参阅手册的 this section)并外部化详尽的文档以避免过多地破坏您的源文件(请参阅手册的 this other section) ).

我还应该补充一点，我以前没有使用 Docbook 的第一手经验，所以这可能会让我偏向于 Doxygen。