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