Report 从源代码生成HTML报告

是否有某种工具（最好是Python）允许您从任意源代码（Python、R、Javascript等）生成HTML、Markdown或StructuredText格式的报告

到目前为止，我发现的最接近的东西是只支持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$，或者在这里

---

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

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

---

请告诉我这个问题有什么问题。否则，我无法改进它。一个问题：预期输出中的hat

42

意味着，除了提取注释外，还应该运行代码？我想不出任何工具能做到这一点，因为代码可能是一个模块，或者是一个需要一些输入的程序。。。您能否澄清该工具应该使用什么作为输入（file.py？），以及您希望该工具如何将注释与执行的代码交织在一起？谢谢。理想情况下，该工具能够提取应该运行的代码，但用户需要提供一种运行它的方法。是的，该工具将使用

file.py

（在上面的示例中）作为输入。我不确定我是否理解你的最后一个问题。你是说该工具应该如何工作以生成最终报告？顺便说一句，我认为在某些情况下，这样的工具不会那么有用（例如，当您的代码不能用注释顺序描述时），为什么不在注释之外添加

print

语句呢？哦，因为我想在一个功能中集成这样的东西来自动生成HTML报告。谢谢。Doxygen看起来很有前途。我使用Doxygen作为我们的C#代码，然后使用JSDoc作为我们的AngularJS代码。phpDocument还用于PHP网站。

42