python怎么查看函数文档

最直接的方法是使用 help() 函数或访问 doc 属性：help() 显示完整文档（含参数、返回值、示例），适合交互环境；__doc__ 直接返回原始 docstring 字符串，适合程序中读取；自定义函数需将三重双引号 docstring 置于函数体首行才生效。

在 Python 中查看函数文档最直接的方法是使用 help() 函数或访问对象的 __doc__ 属性。

用 help() 查看完整文档

help() 会显示函数的完整文档字符串（docstring）、参数说明、返回值、示例等（如果有的话），适合交互式环境（如 IDLE、Jupyter、IPython 或终端 Python）：

• 在 Python 解释器中输入：help(len) 或 help(print)
• 对自定义函数也有效：help(my_function)
• Jupyter/IPython 中还可使用快捷语法：len?（显示简要文档）或 len??（显示源码+文档）

用 __doc__ 属性快速获取原始文档字符串

__doc__ 是函数对象的一个属性，直接返回 docstring 字符串（可能为 None），适合程序中读取或调试：

• print(len.__doc__) → 输出内置函数的文档文本
• print(my_function.__doc__) → 显示你写的 docstring（注意：需已定义且非空）
• 若函数没写 docstring，结果是 None，打印出来就是 None

在编辑器/IDE 中查看文档提示

主流工具支持悬停或快捷键实时查看文档：

立即学习“Python免费学习笔记（深入）”；

• VS Code：鼠标悬停函数名，或按 Ctrl+Shift+Space（Windows/Linux） / Cmd+Shift+Space（macOS）
• PyCharm：按 Ctrl+Q（Windows/Linux） / Cmd+J（macOS）弹出文档窗口
• Vim + jedi-vim：按 K 键

确保文档能被正确查看的小提醒

自己写的函数要让 help() 和 __doc__ 生效，需满足：

• docstring 必须是函数体内的第一个语句（三引号字符串，不能是注释或变量赋值）
• 推荐用三重双引号 """...""" 并遵循 PEP 257 格式
• 示例：
  def add(a, b):
    """Return the sum of a and b."""
    return a + b
  这样 help(add) 就能正常显示