JupiterノートブックのようにPyCharmのdocstringを参考にするにはどうしたらいいですか？

Question

Jupyterノート のコマンドを入力するときにドキュメントと "（）" とJupyterノートブックにはShift + Tabキーを押す（すべてのパラメータを持つ素敵なドキュメンテーション文字列が説明および実施例は現れます）：

PyCharm コマンドを入力し、PyCharmでCtrl + Qを押す時にドキュメント（推測された変数の型を持つ唯一の自動生成ドキュメンテーション文字列が現れる）：

編集 この質問は、外部（例： matplotlibsまたはnumpy）のドキュメントデコレータではなく、独自の美しいドキュメントストリングを書く方法ではありません。

Answer 1

「自分のコードのドキュメントストリングを書く方法」という意味ですか？

Sphinx/reStructuredTextの構文を使用すると、美しい文書を作成できるためです。ここで

は、基本的な例である：

def axhline_demo(y=0, xmin=0, xmax=1, hold=None, **kwargs): 
    """ 
    Add a horizontal line across the axis. 

    Parameters 
    ---------- 

    :param y: scalar, optional, default: 0 

     y position in data coordinates of the horizontal line. 

    :param xmin: scalar, optional, default: 0 

     etc. 

    :param xmax: more documentation... 
    :param hold: 
    :param kwargs: 
    :return: 
    """ 

あなたが得られます。

表示 =>クイックドキュメントメニューを使用してください。