使用项目的源代码创建文档
Create a document with source code of the project
我有一个包含大量源代码的项目。出于文档目的,我必须将所有源代码合并到一个文件中,例如 PDF、HTML 或 DOCX。最好,每个合并的文件内容都应该有一个标题及其相对来源。良好的格式是需要的,但不是强制性的。
有人做过这个任务吗?是否有任何简单的代码片段来自动执行任务?奇怪的是,我四处搜索并没有找到关于这个挑战的任何提示。
如果在 UNIXish 上,a2ps does a really nice job printing large amounts of sources to postscript, which is then trivial to convert to PDF via e.g. ps2pdf。类似于:
a2ps *.c -o foo.ps
ps2pdf foo.ps foo.pdf
这将转储您在命令行上指定的所有源(并且您可以使用 find 和 xargs 或类似的组合进行递归)。如果您不需要完整的源码转储,您最好阅读您语言的本地源码文档(例如 doxygen 或 javadoc 或类似的)。大多数源文档系统都可以输出成一堆格式的 ime。
我有一个包含大量源代码的项目。出于文档目的,我必须将所有源代码合并到一个文件中,例如 PDF、HTML 或 DOCX。最好,每个合并的文件内容都应该有一个标题及其相对来源。良好的格式是需要的,但不是强制性的。
有人做过这个任务吗?是否有任何简单的代码片段来自动执行任务?奇怪的是,我四处搜索并没有找到关于这个挑战的任何提示。
如果在 UNIXish 上,a2ps does a really nice job printing large amounts of sources to postscript, which is then trivial to convert to PDF via e.g. ps2pdf。类似于:
a2ps *.c -o foo.ps
ps2pdf foo.ps foo.pdf
这将转储您在命令行上指定的所有源(并且您可以使用 find 和 xargs 或类似的组合进行递归)。如果您不需要完整的源码转储,您最好阅读您语言的本地源码文档(例如 doxygen 或 javadoc 或类似的)。大多数源文档系统都可以输出成一堆格式的 ime。