使用pandoc作为文档生成器

时间:2014-07-20 23:36:01

标签: comments markdown documentation-generation pandoc code-documentation

我在维基百科页面(Comparison of documentation generators)中看到,pandoc可以用作文档生成器(就像doxygen一样)。

但我没有在pandoc的文档或其网站中找到从源代码注释中提取文档的方法,就像其他文档生成器一样。

那么如何使用pandoc来做到这一点?有一种方法可以从代码注释中提取pandoc的标记语言并从中创建PDF或HTML文档吗?或者维基百科的比较列表是错误的?

1 个答案:

答案 0 :(得分:2)

http://www.ucalgary.ca/rzach/blog/2014/05/simple-way-to-document-code-with-markdown-grep-and-pandoc.html中描述的方法视为mb21,提到一个类似下面的bash脚本来完成工作

"makedoc"

#!/bin/bash

grep -e "^%" -e "^$$" $1.tex | cut --bytes=3-| pandoc -f markdown  -o $1.pdf