Python関数のヘルプ/説明テキストを書く方法

Question

最近、Pythonを使用してプログラミングを始めました。多くの関数を作成する必要があり、関数を呼び出すときにスパイダーのオブジェクトインスペクターに表示されるようにヘルプまたは説明テキストを組み込む方法を考えていました。 MatLabでは、これは関数ファイルの先頭にコメント付きのテキストを配置することで機能しました。 Python（Spyderを使用））に同様のメソッドはありますか？

Answer 1

デフォルトでは、メソッド本体の最初の文字列は、そのdocstring（またはドキュメンテーション文字列）として使用されます。 Pythonは、そのメソッドに対してhelp()が呼び出されたときにこれを使用します。

def foo(bar):
    ''' Takes bar and does
        some things to it '''
    return bar

help(foo)
foo(bar)
    Takes bar and does
    some things to it

PEP-258 を読むことで、これがどのように機能するかについての詳細を読むことができます この質問 は、いくつかの詳細に行きます。

Answer 2

（Spyderのメンテナはここにいる）Spyder自体に関して（@ burhan-khalidが言及したもの以外に）知っておくべきことが他にもいくつかあります。

1. ヘルプペインで適切にフォーマットされたドキュメント文字列を表示する場合は、numpydoc標準に従って記述する必要があります。これについては、 here で説明されています。これは、ほとんどすべてのpython科学パッケージがドキュメント文字列を書き込むために使用する規則のセットです。必須ではありませんが、ドキュメント文字列（プレーンテキストで提供される）をHTMLに変換するときにもこれに従います。

2. あなたが使用する必要があります Ctrl+I オブジェクトの名前の前に、ヘルプペインにヘルプを表示します。