python - 使用当前参数列表生成 python 文档字符串模板

Question

我有一个 python 包即将发布，所以现在我开始使用 vim 慢慢地将文档字符串添加到文件中。所以对于像这样的函数

def foo(x, y, z=None, **kwargs):

我必须一整天手动重复输入以下内容

""" foo does this stuff.

Parameters
----------
x: 
y:
z: optional
kwargs:

Returns
-------

"""

有没有一种方法可以通过定义一些 vim 宏来动态生成这个模板文档字符串(我对此一无所知，所以关于如何开始的建议也很好)。谢谢。

Answer 1

vim-pydocstring 的作者亲切地在包中添加了与 Numpy 风格的文档字符串的兼容性，现在看来这是对这个问题的最佳答案。

您可以从 here 拉取/下载 vim 插件