没有返回任何内容时的文档字符串

Question

当一个函数没有 return 任何内容时，docstring 约定是什么？

例如：

def f(x):
    """Prints the element given as input

    Args:
        x: any element
    Returns:
    """
    print "your input is %s" % x
    return

我应该在文档字符串中的 Returns: 之后添加什么？什么都不像现在？

Answer 1

您应该使用 None，因为这实际上是您的函数 returns:

"""Prints the element given as input

Args:
    x: any element
Returns:
    None
"""

Pythonreturnsomething 中的所有函数。如果你没有明确地 return 一个值，那么它们将 return 默认为 None：

>>> def func():
...     return
...
>>> print func()
None
>>>

Answer 2

你可以简单地省略它。为了简单和减少噪音，您可能应该忽略它。

您使用的文档字符串样式是“Google 样式”，样式指南对 Returns 部分是这样说的：

If the function only returns None, this section is not required.

Docstrings when nothing is returned