1

任意のソース コード (Python、R、Javascript など) から HTML、Markdown、または reStructuredText でレポートを生成できるツール (できれば Python) はありますか?

これまでに見つけた最も近いものは、python のみをサポートするpyreportです。アイデアは、十分に文書化されたソース コードから迅速なレポートを取得できるようにすることです。これは、読み書きのできるプログラミングとは異なります。ここでは、次のようなものが必要です。

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$ またはここにリンク

42

これはドキュメンテーション ジェネレーター ツールと非常によく似ていますが、複数の言語で機能する必要があり、ほとんど (すべてではないにしても) は言語固有です。

4

1 に答える 1

1

Python Wiki for Source Code ドキュメントにリストされているツールの 1 つを使用できますか。通常、このツールはコードから構造を抽出し、ドキュメントに docblock を含めます。

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

于 2015-10-18T16:40:58.100 に答える