从源代码生成HTML报告

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

到目前为止，我发现的最接近的东西是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这里

这与文档生成器工具非常相似，但我需要它们跨语言工作，并且大多数（如果不是全部）语言特定的。

来源

2015-10-09 Robert Smith

Downvoter，请告诉我这个问题有什么问题。否则，我无法改进它。 –

有一个问题：在预期输出中使用'42'，意味着除了提取注释之外，代码应该运行吗？我想不出有什么工具可以这么做，因为代码可能是一个模块，或者是一个需要一些输入的程序......你能澄清一下这个工具应该用什么作为输入（file.py？），以及怎么做您希望该工具将注释与已执行的代码交织在一起？ – jjmontes

谢谢。理想情况下，该工具将能够提取应该运行的代码，但用户需要提供运行它的方法。是的，该工具将使用'file.py'（在上面的例子中）作为输入。我不确定我是否理解你的最后一个问题。你的意思是这个工具应该如何工作来产生最终报告？顺便说一下，我认为在某些情况下，这样的工具并不会如此有用（例如，当您的代码无法用其注释顺序描述时） –

您可以使用Python Wiki中列出的工具之一来源代码文档，它通常从您的代码中提取结构，并在文档中包含您的docblocks。

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

来源

2015-10-18 16:40:58

谢谢。 Doxygen看起来很有希望。 –

我使用Doxygen代替我们的C＃代码，然后使用JSDoc代替我们的AngularJS代码。 PHPDocumenter也用于PHP网站。 –

从源代码生成HTML报告

回答

相关问题