WebStorm 2025.2 Help

查阅 JavaScript 文档

WebStorm 为标准 JavaScript API、项目中以及其依赖项中的符号,以及外部库中定义的符号显示参考信息。 您可以在 文档 弹出窗口中查看符号的文档,并在有链接的情况下打开外部网站上的文档。

  • 对于项目符号或项目依赖项中的符号,WebStorm 会根据相应的 JSDoc 注释 生成文档。

  • 对于标准 JavaScript 对象或方法,WebStorm 会显示内置 TypeScript 定义文件 d.ts 中相应的 JSDoc 注释。 这些文件与 WebStorm 一同提供,并会定期更新。

  • 如果在 d.ts 文件中找不到注释,WebStorm 会显示相应 MDN 文章 的摘要。

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

弹出窗口中的快速文档

弹出窗口中的快速文档
  • 将鼠标悬停在编辑器中的目标符号上。

  • 将光标置于符号上并按 Ctrl+Q ,或在主菜单中选择 视图 | 快速文档

    再次按 Ctrl+Q 可在 文档 工具窗口中打开该文档。

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

在弹出窗口中单击 显示选项菜单图标 可更改字体大小、显示快速文档工具栏或转到源代码。 有关更多信息,请参见 配置快速文档弹出窗口

工具窗口中的快速文档

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

工具窗口中的快速文档查阅
  • 在快速文档弹出窗口中,点击 显示选项菜单图标 ,并取消选择 首先显示“文档”弹出窗口 选项。

  • 文档 工具窗口中,点击工具窗口工具栏上的 显示选项菜单图标 ,并取消选择 首先显示“文档”弹出窗口 选项。

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

在工具窗口中,代码文档显示在未固定的标签页(标有星号符号的标签页中 (*)。 将鼠标悬停在符号上或将光标放在符号上即可查看该文档。 请参见 Quick Documentation 工具窗口:模式

符号的 MDN 文档

  • 文档 弹出窗口 Ctrl+Q 中,点击底部的链接:

    ws_mdn_docs.png
  • Shift+F1 ,或在主菜单中选择 视图 | 外部文档

WebStorm 会在 默认 WebStorm 浏览器 中打开该 MDN 文章。

第三方 JavaScript 库的文档

  1. 下载所需的库或框架,将其配置为外部 JavaScript 库,并指定其外部文档链接。 有关更多信息,请参见 配置自定义第三方 JavaScript 库

  2. 将光标置于符号上并按 Shift+F1 ,或在主菜单中选择 视图 | 外部文档

npm 包的文档

  • package.json 文件或 requireimport 语句中,将光标置于包名上并按 Ctrl+Q

    从 import 语句打开的 npm 包快速文档
    从 package.json 打开的 npm 包快速文档
  • 要在浏览器中打开 npm 官方网站 上的文档,请点击弹出窗口中的链接或按 Shift+F1

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