📅 最后修改于: 2020-04-06 08:58:27 🧑 作者: Mango
Python help函数用于显示模块，函数，类，关键字等的文档。help函数具有以下语法
help([object])如果在不带参数的情况下传递了帮助函数，则交互式帮助实用程序将在控制台上启动。
让我们在Python控制台中检查print函数的文档。
help(print)它提供以下输出：
Help on built-in function print in module builtins:
print(...)
print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
Prints the values to a stream, or to sys.stdout by default.
Optional keyword arguments:
file: a file-like object (stream); defaults to the current sys.stdout.
sep: string inserted between values, default a space.
end: string appended after the last value, default a newline.
flush: whether to forcibly flush the stream.也可以为用户定义的函数和类定义帮助函数输出。docstring(文档字符串)用于文档。它嵌套在三引号内，并且是类，函数或模块中的第一条语句。
让我们定义一个带有函数的类：
class Helper:
def __init__(self):
'''helper初始化'''
def print_help(self):
'''返回helper的描述'''
print('helper的描述')
help(Helper)
help(Helper.print_help)运行上述程序后，我们将获得第一个帮助功能的输出，如下所示：
Help on class Helper in module __main__:
class Helper(builtins.object)
| Methods defined here:
|
| __init__(self)
| The helper class is initialized
|
| print_help(self)
| Returns the help description
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)
Help on function print_help in module __main__:
print_help(self)
Returns the help description