Tools

【VSCode】Python使うならautoDocstringを導入しよう!

Python使うならautoDocstringを導入しよう!

autoDocstringをインストールする

VSCodeのサイドバーをクリックし、docstringと検索します。

検索結果の中に、autoDocstringを見つけてインストールします。

フォーマットを変えてみる

setting.jsonを開きます。

インストールした直後だと、以下のようにdefaultが設定されています。

よくgoogleやNumpyが使われるので、今回はgoogleを設定してみましょう。

setting.jsonの右側に以下のように記述します。

使ってみる

def sample(car, animal, drink):

上記の状態で、コマンド + shift + 2を打つと、以下のようにdocstringのテンプレートが表示されます。

def sample(fruit, animal, drink):
    """[summary]

    Args:
        fruit ([type]): [description]
        animal ([type]): [description]
        drink ([type]): [description]
    """

あとは、[ ]のところを書き換えていくだけです。

また、何かしらのreturnを書いていると、以下のようになります。

def sample(fruit, animal, drink):
    """[summary]

    Args:
        fruit ([type]): [description]
        animal ([type]): [description]
        drink ([type]): [description]

    Returns:
        [type]: [description]
    """
    return fruit + animal

COMMENT

メールアドレスが公開されることはありません。