如何使用VSCode自带Snippets定义Python函数入参注释（参数名及类型）

不需要安装任何第三方插件，仅用VSCode自带的代码片段功能即可实现输入"""自动生成符合规范的函数注释，效果如下：

配置步骤 #

• 打开VSCode命令面板：Windows/Linux按Ctrl + Shift + P，Mac按Cmd + Shift + P
• 搜索并选择「配置用户代码片段」，在弹出的语言列表里选择python.json
• 在打开的json文件中添加如下配置：

{
  "Auto Generate Python Function Docstring": {
    "prefix": "\"\"\"",
    "body": [
      "\"\"\"",
      "",
      "Parameters",
      "----------",
      "${1:参数名 : 类型}",
      "    ${2:参数描述.}",
      "${3:参数名 : 类型}",
      "    ${4:参数描述.}",
      "${5:参数名 : 类型, optional}",
      "    ${6:参数描述. 默认值为 ${7:默认值}.}",
      "",
      "Returns",
      "-------",
      "${8:返回值类型}",
      "    ${9:返回值描述.}",
      "",
      "\"\"\""
    ],
    "description": "自动生成Python函数参数、返回值注释"
  }
}

• 保存配置文件即可生效

使用方法 #

写完Python函数签名后，在下一行输入"""，按下Tab即可触发自动补全，你可以按Tab依次切换占位符，填写参数类型、描述、返回值等信息。
如果输入后没有自动弹出补全提示，可以按Ctrl + Space手动唤出补全列表选择对应片段。

内容的提问来源于stack exchange，提问作者cui xingxing