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

2022-01-19 00:00:00 python function return docstring

问题描述

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

What is the docstring convention when a function doesn't return anything?

例如:

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

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

我应该在文档字符串中的 Returns: 之后添加什么?没有现在的样子?

What should I add after Returns: in the docstring? Nothing as it is now?

解决方案

你应该使用 None，因为这是你的函数实际返回的:

You should use None, as that is what your function actually returns:

"""Prints the element given as input

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

Python 中的所有函数都返回一些东西.如果您没有显式返回值，则默认情况下它们将返回 None:

All functions in Python return something. If you do not explicitly return a value, then they will return None by default:

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

相关文章