VSCodeはPythonのコーディングに非常に便利なエディタで、その中でもautoDocstringという拡張機能は特に注目に値します。この拡張機能を使用すると、PythonのDocstringの記述を補助することができ、コードの可読性を大幅に向上させることが可能です。
autoDocstringのインストールと利用
まずはVSCodeの[Extensions]ボタンをクリックして、autoDocstringで検索を行います。トップに表示されるNils Werner氏が提供するautoDocstringをインストールします。
Pythonスクリプトを作成し、関数の下に3つのダブルクォーテーション\"\"\"の文字列を打ち込みます。この状態からEnterキーを押下すると、説明文と引数と戻り値のコメントフォーマットが自動生成されます。
スタイルの変更
デフォルトだとGoogleスタイルの記法で自動生成されます。スタイルを変更したい場合は、[歯車]アイコン -> Settingを開きます。autoDocstringで検索をかけるとAuto Docstring: Docstring Formatの設定項目が表示されます。プルダウンから利用したいスタイルを選択して変更します。
以上がVSCodeでPythonのコメントを自動生成する方法です。この方法を使えば、Pythonのコーディングがより効率的になり、コードの可読性も向上します。ぜひ試してみてください。