見出し画像

【VSCode拡張機能】docstringを使ってみよう

・docstringとは?

関数などの仕様(どういう処理をして何を戻り値とするのか、呼び出すのに必要なパラメーターなど)をその読み手に対して説明するために、その定義に埋め込んだ形で記述します。関数の説明みたいなものです。



・拡張機能「Python Docstring Generator」をインストール

拡張機能の検索欄から「python docstring」と検索して、
「Python Docstring Generator」をインストールして再起動します。



・Python Docstring Generatorの使い方

生成したい関数直下に「"""」と入力すると、「Generate Docstring」と
表示されるのでクリックします。その後、生成されます。


以下のように、表示されるかと思います。
関数の引数((a:int, b:int) -> int)といった書き方をしておくと自動で入力されるのでおすすめです。


完成形はこちらになります。
関数の内容が分かりやすくなっていいですね!


いいなと思ったら応援しよう!