结合Docbook和Doxygen文档类型.

发布时间：2020-12-16 07:03:52 所属栏目：百科来源：网络整理

导读：我正在为我们的软件库开发新的文档,我想知道如何将我认为应该在DocBook中编写的一般文档与基于Doxygen的API参考相结合. Doxygen部分已经存在,所以我更喜欢保留它,但使用DocBook只是一个想法,我对任何想法持开放态度.在Doxygen中编写整个文档是可能的,但在我

我正在为我们的软件库开发新的文档,我想知道如何将我认为应该在DocBook中编写的一般文档与基于Doxygen的API参考相结合.

Doxygen部分已经存在,所以我更喜欢保留它,但使用DocBook只是一个想法,我对任何想法持开放态度.在Doxygen中编写整个文档是可能的,但在我看来它并不是最好的方法.

谢谢！

我建议你重新考虑采用all-Doxygen方式.即使使用Doxygen编写复杂的文档起初看起来很麻烦,但从长远来看,保持两个Documentations的一致性将会更加有效.除了通过组合两者的输出产品而增加的工作量.

Doxygen可以将Markdown文件作为页面包含在您的文档中(参见本手册的this section)并外化精心设计的文档,以免过多地破坏您的源文件(参见本手册的this other section).

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

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!