查看内联文档
快速文档查阅允许您查看项目及其依赖项中的符号参考信息,也可以查看标准 JavaScript 对象和方法的参考信息。 有关更多信息,请参阅 查阅 JavaScript 文档 和 TypeScript 文档查阅。
对于项目符号或其依赖项中的符号,WebStorm 会根据相应的 JSDoc comment 生成文档。 要创建注释,请将插入符号置于要文档化的方法、函数或字段声明前,输入块注释开头部分 /** ,然后按 Enter。 有关更多信息,请参阅 JSDoc 注释。
默认情况下,文档会显示在 文档 弹出窗口中,但您随时可以在 Documentation 工具窗口 中打开它,甚至可以将其配置为默认显示在 文档工具窗口 中。
当您显式调用代码补全时,建议列表中所选项的快速文档可以自动显示。 快速文档查阅的行为可在设置对话框的 在以下位置显示文档弹出窗口 字段中进行配置,位于 代码补全 页面。
弹出窗口中的快速文档

查看插入符号处符号的文档
将鼠标悬停在编辑器中的所需符号上。
将插入符号置于符号处并按 Ctrl+Q ,或从主菜单中选择 。
再次按 Ctrl+Q 可在 文档 工具窗口中打开此文档。
在弹出窗口中点击
以更改字体大小、显示快速文档工具栏或跳转到源代码。

配置快速文档弹出窗口
更改快速文档的字体大小
指定文档弹出窗口的延迟时间
要指定弹出窗口应在多长延迟后出现,请在 设置 对话框中(Ctrl+Alt+S ),转至 并在 工具提示延迟 字段中输入所需值。
禁用悬停时显示的快速文档
默认情况下,当您将鼠标悬停在代码元素上时,会显示快速文档弹出窗口。 您可以将 IDE 配置为仅在显式调用 快速文档 功能时才显示弹出窗口。
点击弹出窗口中的
,然后禁用 在鼠标移动时显示 选项。
在 设置 对话框中(Ctrl+Alt+S ),转至 并清除 悬停时显示快速文档 复选框。
要在禁用悬停弹出文档的情况下查看插入符号处符号的文档,请按 Ctrl+Q 或从主菜单中选择 。 文档将显示在弹出窗口中,但您可以配置 IDE 立即在工具窗口中显示它。
工具窗口中的快速文档
默认设置下,按 Ctrl+Q ( )将在弹出窗口中打开快速文档。 您可以修改设置以在工具窗口中查看文档。
在快速文档弹出窗口中,点击
,然后禁用 首先显示“文档”弹出窗口 选项。

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

在工具窗口中保留文档
您可以在工具窗口中打开某个特定代码元素的文档,并继续查看当前文件中其他元素的文档。
将插入符放在所需代码元素处,然后按下 Ctrl+Q。 如果弹出窗口出现,请再次按下 Ctrl+Q 以切换到工具窗口。
文档选项卡上的星号符号(
*)表示该选项卡未固定,因此其内容将被编辑器中所选其他代码元素的文档替换。右键单击文档工具窗口中的文档选项卡,然后启用 保留此文档 选项。
之后,当前的文档选项卡将被固定。 您可以返回编辑器,查看其他代码元素的文档,这些文档将显示在弹出窗口或工具窗口的新选项卡中。

在工具窗口中,代码文档显示在未固定的选项卡上(该选项卡带有星号符号(* )标记)。 您可以通过多种方式进行操作:
您可以将鼠标悬停在代码元素上以查看文档。
点击工具窗口工具栏上的 ,然后启用 在鼠标移动时显示 和 从源自动更新 选项。

将插入符放置在编辑器中的符号处查看文档,可以通过点击符号或移动插入符来实现。
点击工具栏上的 ,禁用 在鼠标移动时显示 ,并启用 从源自动更新 选项。

您可以将插入符放在某个符号处,然后按下 Ctrl+Q 或从主菜单中选择 来查看文档。
点击工具窗口工具栏上的 ,禁用 在鼠标移动时显示 和 从源自动更新 选项。
