Python函数的docstring

定义

# 首先定义一个函数
def add(x, y):
    """返回x和y的和"""
    return x + y

docstring

docstring指的是函数说明(也并非全部), 指的是在第一行指定的字符串.

使用help()产看函数docstring

# 在python的shell中调用 help(function)来产看函数function的帮助
# 以上面add函数为例
# 首先打开Terminal, 然后打开python shell. (windows用户可以直接打开安装Python自带的IDLE即可)
bovenson@vmware ~ $ python3
Python 3.5.2 (default, Nov 17 2016, 17:05:23) 
[GCC 5.4.0 20160609] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
# 定义add
>>> def add(x, y):
...     """返回x和y的和"""
...     return x + y
... 
# 调用help()查看docstring
>>> help(add)
Help on function add in module __main__:

add(x, y)
    返回x和y的和
(END)