使用项目的源代码创建文档

Question

我有一个包含大量源代码的项目。出于文档目的，我必须将所有源代码合并到一个文件中，例如PDF，HTML或DOCX。优选地，每个合并文件内容应具有其相对来源的标题。很好的格式是理想的，但不是强制性的。

有人做过这个任务吗？是否有任何简单的代码片段可以自动完成任务？奇怪的是，我四处搜索并没有找到任何关于这一挑战的提示。

Answer 1

如果使用UNIXish，a2ps可以很好地将大量的源打印到postscript，这样就可以轻松地通过例如转换为PDF。 ps2pdf。类似的东西：

a2ps *.c -o foo.ps
ps2pdf foo.ps foo.pdf

这将转储您在命令行中指定的所有源（并且您可以使用find和xargs或类似的一些组合进行递归）。如果您不需要总源转储，那么您可能最好阅读您的语言的本机源文档（如doxygen或javadoc或类似文件）。大多数源文档系统都可以输出为多种格式的数据。