VSCodeの拡張機能「autoDocstring」の使い方を解説します。
1. 拡張機能「autoDocstring」の導入
拡張機能「autoDocstring」は、以下例のようなPythonの関数／メソッドやクラスのドキュメントを自動生成します。引数や戻り値を自動で解析してくれます。
def greet(name: str, age: int = 0) -> str:
"""
Summary line.
Parameters
----------
name : str
Description of name.
age : int, optional
Description of age (default is 0).
Returns
-------
str
Description of return value.
"""
return f"Hello, {name}!"
「autoDocstring」の導入と使い方は以下のとおりです。
① VSCodeの左サイドバー拡張機能から拡張機能「autoDocstring」を検索してインストールします。
② Python ファイルを開き、docstring を生成したい 関数 や クラス の中にカーソルを置きます。
③ ショートカット「Ctrl + Shift + P」でコマンドパレットを表示し、以下を入力してEnterを押しましす。
Auto Docstring: Generate Docstring
④ 関数／メソッドの引数や戻り値を自動で解析し、雛形が挿入されます。
なお、「Github Copilot」で「Generate Docs」をクリックすると、そのフォーマットに上書きしてくれます。
2. ドキュメントのスタイルをカスタマイズ
プロジェクトごと、あるいはワークスペース単位で以下のように settings.json に書くとドキュメントのスタイルをカスタマイズすることができます。
{
// ドキュストリングのスタイル: "google", "numpy", "sphinx" のいずれか
"autoDocstring.docstringFormat": "numpy",
// テンプレート内でクォートを 3重に使うか
"autoDocstring.includeQuotesOnTemplate": true,
// 3重クォートのタイプ。''' or """
"autoDocstring.quotesStyle": "\"\"\""
}
- Google スタイルにしたい →
"google" - NumPy スタイル（Parameters/Returns 見出しが ■●） →
"numpy" - Sphinx（ReST 形式）の場合 →
"sphinx"
3. Aテンプレートの自作
① ワークスペースのルートに autoDocstring.json を作成し、以下のようにプレースホルダを定義します。
{
"customTemplate": {
"function": [
"'''",
"{{summary}}",
"",
"{{#params}}:param {{name}}: {{description}}",
"{{/params}}",
":returns: {{returns}}",
"'''"
]
}
}
② settings.json でテンプレートを選択します。
{
"autoDocstring.customTemplatesPath": "./autoDocstring.json",
"autoDocstring.docstringTemplate": "customTemplate"
}
関連ページ
【VSCode超入門】基本的な使い方から応用例まで解説
VSCode（Visual Studio Code）の基本的な使い方から応用例まで入門者向けに解説します。
windows.joho.info
2025.06.23
Python超入門速報
python.joho.info
【Windows超入門】初心者から上級者までテクニックを解説
Windowsの基本操作と設定基本操作Windowsの基本操作便利なショートカット大全集画面のカスタマイズカスタマイズWindows 11の右クリックメニューを昔のスタイル（Windows 10）に戻す方法Windowsを高速化・軽量化する...
windows.joho.info
2024.06.29
コメント