如何在 VsCode 中自动生成 python 模块的文档字符串片段?

How to auto generate docstring snippets for python modules in VsCode?

提问人:Amin Ba 提问时间:1/23/2022 最后编辑:mkrieger1Amin Ba 更新时间:1/23/2022 访问量:15177

问:

我已经安装了 Visual Studio Code 扩展 Python Docstring Generator,它可以自动生成文档字符串片段。

我使用的自定义设置:

"autoDocstring.docstringFormat": "sphinx",
"autoDocstring.generateDocstringOnEnter": true,
"autoDocstring.includeExtendedSummary": true,
"autoDocstring.guessTypes": true,
"autoDocstring.customTemplatePath": ".vscode/sphinx.mustache",

但是,它主要用于函数的文档字符串。

如何生成:

  • 模块和脚本的文档字符串:在模块开头输入
  • packages:已添加到文件中__init__.py

这方面有什么想法吗?

python-sphinx vscode-extensions 文档字符串

评论

0赞 mkrieger1 1/23/2022
它不会这样做:“Visual Studio Code 扩展,用于快速生成 python 函数的文档字符串。
4赞 mkrieger1 1/23/2022
无需为类和模块生成任何内容,只需键入文档字符串文本,并用 .或者你到底期望它产生什么?"""

答: 暂无答案