1

是否有一些工具(最好在 Python 中)允许您从任意源代码(Python、R、Javascript 等)生成 HTML、Markdown 或 reStructuredText 的报告?

到目前为止,我发现的最接近的是仅支持 python的pyreport 。这个想法是能够从记录良好的源代码中获得快速报告。这与文学编程不同;在这里,我想要类似于以下内容:

文件.py

# ```*This is part of a comment*
# maybe some equations $c^2=a^2+b^2$ or [links](http://mylink.com) here ```
def calculate_something():
    print(42)
calculate_something()

报告应该是这样的:

这是评论的一部分

也许一些方程 $c^2=a^2+b^2$ 或链接在这里

42

这与文档生成器工具非常相似,但我需要它们跨语言工作,而且大多数(如果不是全部)都是特定于语言的。

4

1 回答 1

1

您是否可以使用 Python Wiki for Source Code 文档中列出的工具之一,它通常从您的代码中提取结构,并在文档中包含您的 docblocks。

https://wiki.python.org/moin/DocumentationTools

于 2015-10-18T16:40:58.100 回答