C&C++   发布时间:2022-04-03  发布网站:大佬教程  code.js-code.com
大佬教程收集整理的这篇文章主要介绍了结合Docbook和Doxygen文档类型.大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。
我正在为我们的软件库开发新的文档,我想知道如何将我认为应该在DocBook中编写的一般文档与基于Doxygen的API参相结合.

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

谢谢!

解决方法

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

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

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

大佬总结

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

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

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。