我想写一个片段来将文档字符串添加到 Python 函数:
例如:
def foo(a):
b=a+1
return b
应该产生以下内容
def foo(a):
"""One liner description
Parameters
----------
a : type
some comment
Returns
-------
b : type
some comment
"""
b=a+1
return b
我的第一次尝试是这个片段:
<snippet>
<content><![CDATA[
"""${1:One liner description}
Parameters
----------
${2}
Returns
-------
${3}
"""
]]></content>
<tabTrigger>docstring</tabTrigger>
<scope>source.python</scope>
<description>Adds a docstring skeleton to function</description>
</snippet>
在键入 docstring 和 Tab 时产生以下结果:
def foo(a):
"""One liner description
Parameters
----------
Returns
-------
"""
b=a+1
return b
如何获取在代码片段中自动检测到的参数和返回值，例如示例中的“a”和“b”？
最佳答案
只需添加一个:< 默认值 >在#之后在每个${#}停止点:
<snippet>
<content><![CDATA[
"""${1:One liner description}
Parameters
----------
${2:a} : ${3:type}
Returns
-------
${4:b} : ${5:type}
"""
]]></content>
<tabTrigger>docstring</tabTrigger>
<scope>source.python</scope>
<description>Adds a docstring skeleton to function</description>
</snippet>
关于python - Sublime 3，带有参数和返回的 python 函数文档字符串的片段，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/18759312/