我想在使用该类的文档的附录中包含我的代码的参考手册report
。可以吗?
答案1
问题有点不清楚:
编写软件参考手册大多数时候需要像这样的软件包
listings
或minted
或tcolorbox
设施——所有这些都适合代码片段或小例程或非常小的脚本等。
许多软件程序/对象类的文档都可以用来完成doxygen
,例如,它提供了类浏览器——我不建议直接使用 LaTeX 来实现这一点——我必须用和来记录我编写的软件包(2006 年)并C++
使用Qt
了doxygen
。
doxygen
允许合并LaTeX
或HTML
标记以便导出到.pdf
或.html
页面。
如果需要展示算法,可以使用诸如algorithmic
或之类的各种包来完成algpseudocode
。