Vscode推荐一款适用于Python的快速函数注释插件

Posted 2021-06-30 Xavier Jiezou

演示

安装

功能

• 快速生成文档字符串 (docstring) 片段。
• 可供选择的多种文档字符串格式。
• 通过pep484类型提示、默认值和变量名称自动推断参数类型。
• 支持普通参数、关键字参数、装饰器、错误和参数类型的识别。

格式

• Google (默认)
• docBlockr
• Numpy
• Sphinx
• PEP0257 (敬请期待)

用法

光标必须位于函数定义正下方的行上，才能生成完全自动填充的文档字符串。共有如下的三种调用方式：

• 先输入三个双引号（"""）然后回车
• 也可以直接使用快捷键Ctrl+Shift+2调用（修改快捷键：Keyboard Shortcuts -> generateDocstring）
• 或者右键菜单选项卡：Generate Docstring

设置

settings -> autoDocstring里面可以修改注释风格，引号风格（单引号还是双引号），注释模板等等。

参考

https://github.com/NilsJPWerner/autoDocstring