web-dev-qa-db-ja.com

PyCharmのdocstringのフィールドのタイプを自動生成する方法は？

パラメータを使用して関数を作成すると、PyCharmから:param param_name:フィールドを使用してdocstringを作成するように指示されます。これは非常に便利です。ただし、:type param_name:も追加する必要があります。

それから：

def foo(bar, xyz):
    return bar + xyz

Docstringオプションを生成すると、（Insert 'type' and 'rtype' to the documentation stubenable）：

def foo(bar, xyz):
    """
    :param bar:
    :param xyz:
    """
    return bar + xyz

そしてそれが欲しい：

def foo(bar, xyz):
    """
    :param bar:
    :type bar:
    :param xyz:
    :type xyz:
    """
    return bar + xyz
pythonpycharmdocstring
15
FunkySayu

ドキュメント ：

configured の場合、ドキュメンテーションコメントスタブはtypeおよびrtypeタグを使用して生成できます。

リンクをたどる：

...

  1. スマートキー ページで、チェックボックス'type'と 'rtype'をドキュメンテーションコメントスタブに挿入を選択します。

ドキュメントが更新されていることに注意してください。構成ガイダンスは現在次のようになっています。

ドキュメントコメントを有効にする

  1. エディター|全般|スマートキー PyCharm設定のページ ⌃⌥S。

  2. Enterセクションで、Insert documentation comment stubチェックボックスをオンまたはオフにします。

  3. 次に、ドキュメントコメントスタブオプションにタイププレースホルダーを挿入までスクロールし、必要に応じてチェックボックスをオンまたはオフにします。詳細については、オプションの説明を参照してください。

これを行ったら、定義のパラメータ名にカーソルを置き、スマートキー機能（Alt+Enter、デフォルトで）Docstringで参照するタイプを指定を選択します。これにより、適切なコメント行が挿入されます。同様に、関数/メソッド名にカーソルを置き、[docstringに戻り値の型を指定]を選択できます。

8
jonrsharpe

Settings > Editor > General > Smart Keysに移動し、Insert type placeholders in the documentation comment stubのチェックボックスをオンにします。

enter image description here

7
PinHao Bill Chen

このチェックボックスを有効にするだけです：

エディター-一般-スマートキー-ドキュメントのコメントスタブにタイププレースホルダーを挿入します。

また、このアイテムを有効にして、 Alt+enter ドキュメントを自動挿入するには：

エディター-一般-スマートキー-ドキュメントコメントスタブの挿入

3
Woogux Wu

あなたが尋ねたものはすでに返答されていますが、私はあなたが使用できるという点に関連があると思います

def foo(bar, xyz):
    """


    :param bar_type bar:
    :param xyz_type xyz:
    """
    return bar + xyz

表示bar_typeおよびxyz_type変数のタイプ。良いヒントは、|は、可能なタイプを複数設定します。例：

def foo(bar, xyz):
    """


    :param float|int bar:
    :param numpy.array xyz:
    """
    return bar + xyz
0
Marco Aguiar