help Python · 内置函数

`help` 查看函数、模块、类等的帮助文档。就像查字典或说明书，了解某个东西怎么用。千万不要理解为救命的意思！

怎么用

help(对象)

小例子

help(print)   # 查看 print 函数的帮助

说明

Help on built-in function print in module builtins:
print(...)
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
    ...

对比：直接看文档字符串

def 函数():
    """这是函数的说明"""
    pass
print(函数.__doc__)   # 这是函数的说明
help(函数)   # 更详细，包含参数等

常见使用场景

1. 学习新函数、模块。
2. 在交互环境中快速查询。
3. 调试时了解对象属性。

提醒：- 在交互式环境中，输入 `help()` 进入帮助模式。 - 可以查看模块、类、函数、关键字等。 - 对于自定义函数，写好文档字符串能让 `help` 更有用。

官方文档：https://docs.python.org/zh-cn/3/library/functions.html#help