推荐使用 AutoDocstring 插件,它是 VSCode 中为 Python 自动生成 Docstrings 最成熟、轻量且兼容性好的选择,支持 Google/NumPy/reST/Sphinx 格式,可自动补全参数、返回值等字段,开箱即用。
推荐使用
AutoDocstring
插件,它是 VSCode 中为 Python 自动生成 Docstrings 最成熟、轻量且兼容性好的选择。
为什么选 AutoDocstring
它支持多种文档字符串格式(Google、NumPy、reStructuredText、Sphinx),能根据函数签名自动补全参数、返回值、异常等字段,且与 VSCode 的代码片段功能深度集成,触发快捷自然。
输入
后按
Enter
或使用快捷键
(Windows/Linux)或
(
mac
OS)即可生成
支持类、函数、方法、模块级 docstring,也兼容类型提示(PEP 561/585)
无需配置即可开箱即用,高级用户可通过设置自定义模板和默认格式
其他可选插件(按场景补充)
Python Docstring Generator
:界面更直观,带可视化表单填写,适合初学者或需要频繁手动调整字段的场景;但更新较慢,对新版本 Python 支持略滞后。
IntelliCode
(
微软
官方):不专为 docstring 设计,但在编写函数时会基于上下文智能建议描述和参数说明,适合作为辅助补充,不能一键生成完整结构。
微软爱写作
微软出品的免费英文写作/辅助/批改/评分工具
下载
立即学习
“
Python免费学习笔记(深入)
”;
简单配置建议
在 VSCode 设置中搜索
,将
设为
(推荐)或
;开启
可自动加入类型提示信息。
基本上就这些 —— AutoDocstring 足够覆盖日常开发中 95% 的 docstring 生成需求,不复杂但容易忽略。
"""Ctrl+Shift+2Cmd+Shift+2autodocstringautoDocstring.docstringFormatgooglenumpyautoDocstring.includeAttributeType