WebStorm 2025.3 Help

查看内联文档

快速文档查找 允许您查看项目及其依赖项中的符号参考,以及标准 JavaScript 对象和方法的参考。 有关更多信息,请参阅 JavaScript 文档查找TypeScript 文档查找

对于项目符号或项目依赖中的符号,WebStorm 会从相应的 JSDoc 注释 生成文档。 要创建注释,请将插入符号放在要记录的方法/函数或字段的声明之前,键入块注释的开头 /** ,然后按 Enter。 如需更多信息,请参阅 JSDoc 注释

默认情况下,文档显示在 文档 弹出窗口中,但您始终可以在 Documentation 工具窗口 中打开,甚至可以将其配置为默认在 文档工具窗口 中显示。

当您显式调用代码补全时,建议列表中选定条目的快速文档可以自动显示。 快速文档查找的行为在设置对话框 代码补全 页面上的 在以下位置显示文档弹窗 字段中配置。

弹出窗口中的快速文档

弹出窗口中的快速文档

查看插入符号处的符号文档

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

  • 将文本光标放在符号处并按 Ctrl+Q 或从主菜单中选择 查看 | 快速文档

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

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

    配置快速文档弹出窗口

配置快速文档弹出窗口

更改快速文档的字体大小

  • 在快速文档弹出窗口中点击 显示选项菜单图标 ,选择 调整字体大小 并移动滑块。

  • 按住 Ctrl 键的同时滚动鼠标滚轮。

    请注意,要使此功能正常工作,您需要在编辑器设置的 通用 页面中启用它。

    有关更多信息,请参阅 有用的编辑器配置

指定文档弹出窗口的延迟时间

  • 要指定弹出窗口出现的延迟时间,请在 设置 对话框(Ctrl+Alt+S )中,转到 编辑器 | 代码编辑 | 编辑器工具提示 并在 工具提示延迟 字段中输入所需的值。

在悬停时禁用快速文档

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

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

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

要查看插入符号处的符号文档并禁用悬停时的文档弹出窗口,请按 Ctrl+Q 或从主菜单中选择 视图 | 快速文档。 文档将显示在弹出窗口中,但您可以配置 IDE 以 在工具窗口中显示

工具窗口中的快速文档

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

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

    快速文档弹出窗口:清除“首先显示弹出窗口”
  • 文档 工具窗口中,点击工具窗口工具栏上的 显示选项菜单图标 并禁用 首先显示“文档”弹出窗口 选项。

    快速文档工具窗口:清除“首先显示弹出窗口”

将文档保存在工具窗口中

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

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

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

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

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

    在工具窗口中保留快速文档

在工具窗口中,代码文档显示在未固定的选项卡上(以星号符号(* )标记的选项卡)。 您可以通过几种方式使用它:

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

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

悬停查看

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

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

查看插入符号处的符号

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

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

使用快捷键查看文档
最后修改日期: 2025年 12月 8日