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

Question

当函数不返回任何内容时，文档字符串的约定是什么？

例如：

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
>>>