结合Docbook和Doxygen文档类型.

结合Docbook和Doxygen文档类型.,第1张

概述我正在为我们的软件库开发新的文档,我想知道如何将我认为应该在DocBook中编写的一般文档与基于Doxygen的API参考相结合. Doxygen部分已经存在,所以我更喜欢保留它,但使用DocBook只是一个想法,我对任何想法持开放态度.在Doxygen中编写整个文档是可能的,但在我看来它并不是最好的方法. 谢谢! 我建议你重新考虑采用all-Doxygen方式.即使使用Doxygen编写复杂的文 我正在为我们的软件库开发新的文档,我想知道如何将我认为应该在DocBook中编写的一般文档与基于Doxygen的API参考相结合.

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

谢谢!

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

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

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

总结

以上是内存溢出为你收集整理的结合Docbook和Doxygen文档类型.全部内容,希望文章能够帮你解决结合Docbook和Doxygen文档类型.所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错,欢迎将内存溢出网站推荐给程序员好友。

欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/langs/1226592.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2022-06-05
下一篇 2022-06-05

发表评论

登录后才能评论

评论列表(0条)

保存