在 Vim 中自动生成 Python 函数注释文档

Pydocstring - Python文档字符串的生成器

能够自动生成函数文档注释、类文档注释,包含以下功能。

原仓库地址
查看效果图

用法

将光标移动到 def 或 class 关键字所在行,在命令模式中输入 :Pydocstring 并按下回车键, 就可以看到文档字符串模板出现在当前行的下方,会根据已有的代码规则自动识别包含函数名、参数类型、参数以及返回值类型。

关键映射

如果要更改默认键映射(输入指令打印注释串),可以在.vimrc中设置以下内容实现自定义的目的。

nmap (pydocstring)

  • 函数文档效果图
    在 Vim 中自动生成 Python 函数注释文档_第1张图片
  • 指定参数和返回值的类型
    相关文档: https://python3-cookbook.readthedocs.io/zh_CN/latest/c07/p03_attach_informatinal_matadata_to_function_arguments.html
    在 Vim 中自动生成 Python 函数注释文档_第2张图片

你可能感兴趣的:(python)