本日は VSCode の環境構築枠です。
VisualStudioCodeでPythonスクリプトのコメント記述の補助を行うautoDocstringを利用する手順を記事にします。
以下の記事の続きです。
bluebirdofoz.hatenablog.com
autoDocstringとは
Python の Docstring の記述を補助を行う VSCode の拡張機能です。
marketplace.visualstudio.com
Docstring は Python の関数やクラスの説明文を記述するコメント規則の一つです。
Google と NumPy の2つのスタイルがあります。
www.sphinx-doc.org
autoDocstringのインストールと利用
Visual Studio Code を起動し、[Extensions]ボタンをクリックして[autoDocstring]で検索を行います。
トップに表示される Nils Werner 氏が提供する[autoDocstring]をインストールします。
早速 autoDocstring を使ってみます。
Python スクリプトを作成し、関数の下に3つのダブルクォーテーション """ の文字列を打ち込みます。
この状態から Enter キーを押下すると、以下の通り、説明文と引数と戻り値のコメントフォーマットが自動生成されます。
スタイルの変更
デフォルトだと Google スタイルの記法で自動生成されます。
スタイルを変更したい場合は[歯車]アイコン -> Setting を開きます。
[autoDocstring]で検索をかけると[Auto Docstring: Docstring Format]の設定項目が表示されます。
プルダウンから利用したいスタイルを選択して変更します。
試しに numpy スタイルを選択してコメントを自動生成してみました。
以下の通り、NumPy スタイルのコメントが生成されるようになります。
