没有任何回复时的文档字符串

Question

当函数没有返回任何内容时，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，因为这是您的函数实际返回的内容：

"""Prints the element given as input

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

Python中的所有函数都返回某些内容。如果您没有显式返回值，则默认情况下它们将返回None：

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