VSCodeはPythonの開発に非常に便利なエディタで、その中でもautoDocstringという拡張機能はPythonのコメント記述を助ける優れたツールです。
autoDocstringとは
autoDocstringはVSCodeの拡張機能で、PythonのDocstringの記述を補助します。DocstringはPythonの関数やクラスの説明文を記述するコメント規則の一つで、GoogleとNumPyの2つのスタイルがあります。
autoDocstringのインストールと利用
- Visual Studio Codeを起動し、[Extensions]ボタンをクリックして
autoDocstringで検索を行います。 - トップに表示されるNils Werner氏が提供する
autoDocstringをインストールします。 - Pythonスクリプトを作成し、関数の下に3つのダブルクォーテーション
"""の文字列を打ち込みます。 - この状態からEnterキーを押下すると、説明文と引数と戻り値のコメントフォーマットが自動生成されます。
スタイルの変更
デフォルトだとGoogleスタイルの記法で自動生成されます。スタイルを変更したい場合は[歯車]アイコン -> Settingを開きます。autoDocstringで検索をかけるとAuto Docstring: Docstring Formatの設定項目が表示されます。プルダウンから利用したいスタイルを選択して変更します。
以上で、VSCodeでPythonのコメントを自動生成する設定が完了です。これにより、Pythonのコードをより効率的に、そして整理された形で書くことが可能になります。