環境構築する際に入れ忘れててdocstringを書くときに困ったので備忘録として残します。
拡張機能autoDocstringについて
導入方法
拡張機能の検索で「autoDocstring」と入れると出てくるのでインストールする
初期設定
ファイル -> 基本設定 -> 設定 を選択
検索に「autoDocstring」と入れて検索すると設定ができる。
「Auto Docstring: Docstring Format
Which docstring format to use.」を好きなスタイルに変更する
使い方
docstringを挿入したい場所に「右クリック」-> 「GenerateDocstring」
または、ショートカットキー「Ctrl + Shift + 2」で呼び出す
▼右クリック時のメニュー
▼自動生成されたdocstring
docstringのスタイル（記述法）について
docstringのスタイル（記述法）については以下リンクがわかりやすい。
googleとNumPyスタイルが2強らしい、僕は記述がシンプルなgoogle派
sphinx.ext.napoleon -- NumPy および Google スタイルの docstring をドキュメントに取り込む — Sphinx documentation
www.sphinx-doc.org
まとめ
拡張機能を使って、少しでも楽をして開発をしよう。
環境構築時に入れるやつ一覧作っておいた方が良い（戒め）便利なツール見つけても後でやろうとして忘れるので備忘録を作ろう
コメント