擅长:python、mysql、java
<p>作为斯特凡.stt的答案是,<code>:return:</code>字段允许您提供函数返回值的描述。然而,斯特凡.stt的示例显示了<code>:return:</code>用于记录返回值<em>类型</em>,而不是用来描述值。为了记录类型,通常使用<code>:rtype:</code>字段,因此:</p>
<pre class="lang-python prettyprint-override"><code>def user_name():
"""
Description of the function goes here.
:return: the name of the currently active user
:rtype: str
"""
</code></pre>
<p>字段名没有完全标准化,并且<code>:returns:</code>也被广泛用于记录返回值;我的印象是{<cd4>}是这两个同义词中更常用的,但是PyCharm的“Python集成工具”已经对<code>:result:</code>进行了标准化。广泛使用的Python文档生成器Sphinx<a href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists" rel="nofollow noreferrer">supports both variants</a>,但其他文档工具可能没有。在</p>
<p>还值得注意的是,在Python docstring中,有几种不同的语法用于记录参数、返回值等。最常见的记录在<a href="https://stackoverflow.com/a/24385103/6947739">this answer</a>中。在</p>