从源代码

时间:2015-10-09 22:32:28

标签: report documentation-generation literate-programming

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

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

file.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 $或links这里

42

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

1 个答案:

答案 0 :(得分:1)

您是否可以使用Python Wiki上列出的源代码文档中的一种工具,它通常从您的代码中提取结构,并在文档中包含您的docblock。

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