百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
A

autoDocstring

> 编程语言
开源

一个 VSCode 扩展,用于为 Python 文件生成文档字符串

737 stars0 点赞1 次浏览
访问官网GitHub

工具介绍

一个 VSCode 扩展,用于为 Python 文件生成文档字符串

autoDocstring: VSCode Python 文档字符串生成器

  • docBlockr
  • doxygen
  • google
  • numpy
  • 一行 Sphinx
  • pep257
  • sphinx

使用方法

Cursor 必须位于定义的直接下一行,才能生成完全自动填充的文档字符串

  • 在使用三重引号 (可配置的 """" 或 "'''") 打开文档说明后按 Enter 键
  • 键盘快捷键: ctrl+shift+2 或 cmd+shift+2 (Mac)
  • 可在「偏好设置」->「键盘快捷键」->「extension.generateDocstring」中更改
  • 指令: 生成文档字符串
  • 右键菜单: 生成文档说明

扩展设置

此扩展提供以下设置:

  • autoDocstring.docstringFormat: 切换不同的文档字符串格式
  • autoDocstring.customTemplatePath: 自定义文档字符串模板的路径(绝对或相对于项目根目录)
  • autoDocstring.generateDocstringOnEnter: 在打开文档字符串后按 Enter 键生成文档字符串
  • autoDocstring.includeExtendedSummary: 在文档字符串中包含扩展摘要部分
  • autoDocstring.includeName: 在文档字符串开头包含函数名称
  • autoDocstring.startOnNewLine: 在摘要占位符之前插入新行
  • autoDocstring.guessTypes: 从类型提示、默认值和变量名称推断类型
  • autoDocstring.quoteStyle: 文档字符串的引号格式

自定义文档字符串模板

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

TypeScript

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言