PhpStorm 2021.3 Help

JavaScript 文档查找

PhpStorm 向您展示标准 JavaScript API、项目及其依赖项中的符号以及外部库中定义的符号的参考。您可以在文档弹出窗口中查看符号文档,获取有关方法参数的信息,并在外部站点上打开文档(如果指向它们的链接可用)。

  • 对于项目符号或项目依赖项中的符号,PhpStorm 从相应的JSDoc 注释生成文档。

  • 对于标准的 JavaScript 对象或方法,PhpStorm 显示来自内置TypeScript 定义文件 d.ts的相应 JSDoc 注释。这些文件与 PhpStorm 捆绑在一起并定期更新。

  • 如果在d.ts文件中没有找到评论,PhpStorm 会显示来自相应MDN 文章的摘要。

查看符号的文档

  • 将插入符号放在符号上,然后按Ctrl+Q或选择查看 | 主菜单中的快速文档查找

  • 当您将鼠标指针悬停在符号上时,PhpStorm 会立即在文档弹出窗口中显示它的引用。

    您可以关闭此行为或将弹出窗口配置为更快或更慢,请参阅下面的配置文档弹出窗口的行为

配置文档弹出的行为

  • 要关闭自动显示文档,请打开Settings/Preferences对话框 ( Ctrl+Alt+S),转到Editor | Code Editing,并清除Show quick documentation on hover复选框。

  • 要更快或更慢地显示文档弹出窗口,请打开设置/首选项对话框 ( Ctrl+Alt+S),转到编辑器 | 一般 | Code Completion,然后选择Show the documentation popup复选框并指定延迟时间。

查看符号的 MDN 文档

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

    ws_mdn_docs.png
  • Shift+F1或选择查看 | 主菜单中的外部文档

PhpStorm 在默认的 PhpStorm 浏览器中打开 MDN 文章。

查看第三方 JavaScript 库的文档

  1. 下载所需的库或框架,将其配置为外部 JavaScript 库,并指定指向其外部文档的链接,详情请参阅配置自定义第三方 JavaScript 库

  2. 将插入符号放在相关符号上,然后按Shift+F1或选择查看 | 主菜单中的外部文档

查看 npm 包的文档

  • package.json文件或requireorimport语句中,将插入符号放在包的名称处,然后按Ctrl+Q

    ws_quick_doc_for_npm_package.png
  • 要在浏览器中打开npm 官方网站上的文档,请按Shift+F1

在工具窗口中查看参考

  • 固定文档弹出窗口。它变成了文档工具窗口,带有相应的侧边栏图标和更多控件。

  • 要在文档弹出窗口和文档工具窗口之间切换,请按Ctrl+Q顺序按。

更改快速文档的字体大小

  • 单击滑块图标快速文档窗口右上角的 ,然后移动滑块。

  • Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到Editor | 常规并选择使用 Ctrl+鼠标滚轮更改字体大小(缩放)复选框。有关详细信息,请参阅 有用的编辑器配置

最后修改时间:2021 年 10 月 8 日