More than 1 year has passed since last update.

VScodeでPython docstringを作成する

Posted at 2022-01-08

備忘録として

※ """ (ダブルクォーテーション3つ)でも生成できますが、入力の手間を考えるとショートカットキーを使う方が良いでしょう

あとは[sumary]や[description]欄に適宜関数や引数の情報を記述していきましょう。

「Python Docstring Generator」ではdocstringに4通りのスタイルが利用可能です。

標準的な形式です

docblockrをよりシンプルにした形です。個人的にはこれが好みです

パラメータの名前と型が縦に並んでいます。どうしてもdocstringが縦長になるので可読性が低くなります。

②と③のあいの子みたいな感じです。

関数の動作に影響しないので、個人開発では好み・チーム開発ではチームのルールに合わせれば良いでしょう。
私はgoogleがシンプルで好みです。(デフォルトの設定もgoogleになっています)

Python for VSCodeという拡張機能が有効になっている場合、戻り値の型が指定されているとdocstringが正しく表示されません。

詳しい原因は分かりませんがPython for VSCodeが有効化されていると、シンタックスハイライトに影響するようです。

差支えなければ無効にするかアンインストールしてしまってよいでしょう。
(レビューも低評価が多いですね...)