PyCharm 2025.2 Help

代码参考信息

本节描述如何查看符号定义、显示文档参考以及使用查看参数信息功能。

参数信息

形参信息 弹出窗口显示方法与函数调用中的参数名称。 PyCharm 会在您在编辑器中输入左括号或从建议列表中选择方法后 1 秒(1000 毫秒)内自动显示包含所有可用方法签名的弹窗。

如果弹出窗口已关闭或您的 IDE 配置为不自动显示弹出窗口 ,您可以显式调用弹出窗口。 要做到这一点,请按 Ctrl+P (或点击 视图 | 形参信息)。

查看参数信息

显示完整的方法或函数签名

默认情况下,参数信息弹出窗口显示简单签名。 您可以配置 IDE 以显示包含方法名和返回类型的完整签名。

  • 设置 对话框(Ctrl+Alt+S )中,转到 编辑器 | 常规 | 代码补全 ,并选中 显示完整的方法签名 复选框。

确保在项目源路径中包含所需的第三方 JavaScript 库。 否则,将不会显示参数名称。

配置参数信息弹出窗口

  1. 设置 对话框(Ctrl+Alt+S )中,转到 编辑器 | 常规 | 代码补全

  2. 在...毫秒内显示参数信息弹出窗口 字段中,指定弹出窗口出现的时间(以毫秒为单位)。

    如果您不希望弹出窗口自动出现,请取消选中 在...毫秒内显示参数信息弹出窗口 复选框。

内嵌提示

内嵌提示是出现在编辑器中的特殊标记,为您的代码提供额外信息。

嵌入提示示例

某些提示默认已启用。

您可以在 设置 | 编辑器 | 嵌入提示 中微调内嵌提示。 有关每种类型功能的详细说明,请参阅 内嵌提示

快速文档

您可以使用 快速文档 功能直接从编辑器获取任何符号的快速信息。 当您将鼠标悬停在代码元素上时,它会在弹出窗口中向您显示代码文档。

PyCharm 识别根据 PEP-257 创建的内联文档。

弹出窗口中的快速文档

在弹出窗口中查看快速文档

  • 在编辑器中将鼠标悬停在所需符号上。

  • 将插入符号放在符号上并按 Ctrl+Q视图 | 快速文档)。

    再次按下 Ctrl+Q 键,以在 文档 工具窗口中打开此文档。

请在弹出窗口中点击 显示选项菜单图标 更改字体大小、显示快速文档工具栏或转到源代码。

在悬停时禁用快速文档

默认情况下,当您将鼠标悬停在代码元素上时,会弹出快速文档。 您可以配置 IDE 以仅在您明确调用 快速文档 功能后显示弹出窗口。

  • 在弹出窗口中点击 显示选项菜单图标 并禁用 在鼠标移动时显示 选项。

  • 设置 对话框 (Ctrl+Alt+S) 中,转到 编辑器 | 代码编辑 | 快速文档 并清除 悬停时显示快速文档 复选框。

    在这种情况下,要查看文本光标处的文档,请按 Ctrl+Q 或从主菜单中选择 视图 | 快速文档。 文档将显示在弹出窗口中,但您可以配置 IDE 以 在工具窗口中显示

工具窗口中的快速文档

在工具窗口中查看文档

默认设置下,按 Ctrl+Q (视图 | 快速文档) 会在弹出窗口中打开快速文档。 您可以更改设置以在工具窗口中查看文档。

  • 在快速文档弹出窗口中,点击 显示选项菜单图标 并禁用 首先显示“文档”弹出窗口 选项。

  • 文档 工具窗口中,点击工具窗口工具栏上的 显示选项菜单 图标,然后禁用 首先显示“文档”弹出窗口 选项。

将文档保存在工具窗口中

您可以在工具窗口中打开特定代码元素的文档,并在当前文件中继续查看其他元素的文档。

  1. 将文本光标放在所需的代码元素并按 Ctrl+Q。 如果弹出窗口出现,请再次按 Ctrl+Q 以切换到工具窗口。

    文档选项卡上的星号符号 (*) 表示该选项卡未固定,因此其内容将被编辑器中您选择的其他代码元素的文档替换。

  2. 右键点击文档工具窗口中的文档选项卡并启用 保留此文档 选项。

    之后,当前文档选项卡将被固定。 您可以返回编辑器并查看其他代码元素的文档,这些文档将在弹出窗口或工具窗口的新选项卡中打开。

您可以通过将鼠标悬停在代码元素上查看文档。

点击工具窗口工具栏上的 选项 图标,启用 在鼠标移动时显示从源自动更新 选项。

您可以在编辑器中将文本光标放置在符号上,通过点击它们或移动文本光标查看文档。

点击工具栏上的 选项 图标,禁用 在鼠标移动时显示 选项并启用 从源自动更新 选项。

您可以通过将文本光标放在一个符号上并按下 Ctrl+Q 或从主菜单中选择 视图 | 快速文档 来查看文档。

点击工具窗口工具栏上的 选项 图标,禁用 在鼠标移动时显示从源自动更新 选项。

外部文档

外部文档会在网络浏览器中打开必要信息,以便您可以导航到相关符号,并同时保留信息以供进一步参考。 PyCharm 显示 SciPy、NumPyPyGTK 和您为 Python 解释器安装的其他模块的文档。 应在设置的 外部文档 页面中正确配置外部文档。

查看外部文档

  • 要在浏览器中查看光标处符号的文档,请按 Shift+F1 或从主菜单中选择 视图 | 外部文档

要查看外部文档,您需要先配置文档 URL。 PyCharm 包含 pandas、wx、kivy、PySide、PyQt5、PyQt4、matplotlib、pyramid、flask 和 gtk 的 URL。 您可以在项目 设置 中修改预定义的 URL 集或添加新的 URL。

配置外部文档

  1. 设置 对话框(Ctrl+Alt+S )中打开 工具 | 外部文档

    配置外部文档
  2. 要添加新的文档 URL,请点击 添加按钮。 在打开的对话框中,指定模块名称和相应外部文档的 URL。

    为 numpy 文档添加 URL

    如果外部文档位于本地,请指定其本地路径。

  3. 要修改任何预配置的文档 URL,请在 工具 | 外部文档 对话框中选择文档模块并双击它或点击 Edit 按钮

  4. 要设置 URL 模式,请在 可用宏 字段中选择宏并点击 插入 按钮。

    修改 matplotlib 文档的 URL

    请注意,每个文档模块都有其特定的结构,因此在添加宏时要小心。

类型信息

在 PyCharm 中,您可以识别表达式的类型。

  • 将文本光标放在必要的代码元素处,然后按 Ctrl+Shift+P。 或者,从主菜单中选择 视图 | 类型信息

提高效率的提示

将工具提示文本复制到剪贴板

要将工具提示文本复制到剪贴板,请按住 Alt (在 Linux 上,按住 Ctrl+Alt )并点击工具提示。

查看上下文信息

如果当前方法或类声明不可见,您可以通过按 Alt+Q 在工具提示中查看。

最后修改日期: 2025年 9月 26日