WebStorm 2025.3 Help

代码补全

基本代码补全帮助您完成类、方法、字段和关键字的名称,这些名称在可见范围内。

WebStorm 分析上下文并建议从当前插入符号位置可以访问的选项。 来自 JSDoc 注释、 TypeScript 类型定义 等的附加信息也可以显著提高补全效果。 建议还包括 实时模板。 代码补全支持非英文键盘布局。

代码补全

补全同样适用于第三方代码中的符号。 在大多数情况下,您只需 将所需文件添加到您的项目中

调用基本补全

  1. 默认情况下,WebStorm 会在您输入时自动显示代码补全弹出窗口。

    或者,您可以按 Ctrl+Space 或从主菜单中选择 代码 | 代码补全 | 基本

    完成弹出窗口
  2. 要缩小建议列表的范围,请输入预期名称或关键字的任何部分(甚至接受中间的字符),或在点分隔符后调用代码补全。 WebStorm 显示包含任意位置输入字符的建议。

    输入时建议列表会缩小范围

从列表中接受一个建议

  • Enter 或双击相关列表项,将其插入到插入符号的左侧。

  • 请按 Tab 替换插入点右边的字符。

  • 使用 Ctrl+Shift+Enter 使当前代码结构在语法上正确(平衡括号、添加缺失的大括号和分号等)。

  • 配置补全设置 中所述,使用特定语言和上下文相关的按键插入所选补全建议。

查看所选建议的引用

  • 要快速查阅文档,请在建议列表中选择一个项目并按 Ctrl+Q。 WebStorm 会在 文档 弹窗中为您显示其快速文档。

    基本补全:文档查阅
  • 要在具有更多控件的工具窗口中查看文档,请固定 文档 弹窗。 要在 文档 弹窗和 文档工具窗口 之间切换,请依次按 Ctrl+Q

  • 要查看所选建议的 定义 ,请按 Ctrl+Shift+I

    基本补全:定义查阅

查看代码层次结构

在建议列表中选择一个条目,然后按以下快捷键之一:

  • Ctrl+H 查看类型层次结构

  • Ctrl+Alt+H 查看调用层次结构。

  • Ctrl+Shift+H 查看方法层次结构。

有关更多信息,请参阅 构建层次结构

显示新类字段、变量和参数名称的建议

除了完成现有符号的调用外,WebStorm 还可以在声明新类字段、变量和参数时建议名称。 这些建议是基于您的项目中定义的类、类型和接口的名称,您使用的库以及标准 API。

新声明变量的建议名称

默认情况下,此功能是关闭的。

  1. 转到 编辑器 | 常规 | 代码完成 设置页面  Ctrl+Alt+S

  2. JavaScript 部分,选择 建议变量和参数名称为类字段建议名称 复选框。

    如果适用,启用显示建议参数名称的类型注解。

    启用新符号的建议

来自 TypeScript Language Service 的 JavaScript 补全

您可以通过使用 TypeScript Language Service 的建议来增强 JavaScript 文件中的基本代码补全。 了解更多信息,请参阅 验证 TypeScript

  1. 打开一个 jsconfig.json tsconfig.json 文件,并向其中添加 'allowJS' : true

  2. 按下 Ctrl+Alt+S 打开设置,然后选择 语言与框架 | TypeScript

  3. 在打开的 TypeScript 页面上,确保选中 TypeScript 语言服务 复选框。

重写的补全

当您想要重写父类或接口中的方法并从补全建议列表中选择此方法时,WebStorm 会自动添加参数,生成 super() 调用,并在可能的情况下添加类型信息。

完成重写:生成方法体

关闭重写方法体的生成

  1. 设置 对话框(Ctrl+Alt+S ),转到 语言与框架 | JavaScript

  2. 在打开的 JavaScript 页面上,清除 在重写的补全中展开方法主体 复选框。

机器学习辅助的代码补全排序

WebStorm 允许您根据其他用户在类似情况下的选择来优先考虑补全建议。

ML 补全机制不会添加任何新元素,而是对从代码中检索的元素进行排序。 数据不会暴露在任何地方;它是在本地收集的。

启用 ML 补全排序

  1. Ctrl+Alt+S 打开设置并选择 编辑器 | 常规 | 代码完成

  2. 机器学习辅助补全 下,启用 根据机器学习对补全建议进行排序 选项,并选择您希望使用 ML 补全的语言。

    ML 辅助补全设置

启用相关性标记

  1. Ctrl+Alt+S 打开设置并选择 编辑器 | 常规 | 代码完成

  2. 启用以下选项:

    • 在补全弹出窗口中标记位置更改 :使用 机器学习排名提升机器学习排名降序 图标来指示建议的重要性是增加还是减少,因此建议已在建议列表中上移或下移。

    • 在补全弹出窗口中标记最相关的条目 :请使用 与机器学习相关的建议 图标标识列表中最合适的建议。

    显示相关性标记
    隐藏相关性标记

配置代码补全行为

要自定义默认补全行为,请转到 编辑器 | 常规 | 代码完成 设置页面  Ctrl+Alt+S 并更新默认补全设置。

要直接从补全弹窗访问代码补全设置,请点击 图标并选择 代码补全设置

打开补全设置

之后, 编辑器 | 常规 | 代码完成 设置页面  Ctrl+Alt+S 将打开。

要调整 JavaScript 上下文中的补全,请使用 JavaScript 区域 中的控件。

在输入时自动显示建议列表

  1. 按下 Ctrl+Alt+S 打开设置,然后选择 编辑器 | 常规 | 代码完成

  2. 请选择 在输入时显示建议 复选框。 如果复选框被清除,您必须通过按 Ctrl+Space 调用基本补全或按 Ctrl+Shift+Space 调用类型匹配补全。

    您还可以选择在只有一个选项时自动插入建议:在 自动插入单个建议 下选择补全类型。

按字母顺序显示建议

  • 按下 Ctrl+Alt+S 以打开设置,然后选择 编辑器 | 常规 | 代码完成

  • 请选择 按字母顺序排序建议 复选框。 默认情况下,复选框被清除,建议按其相关性排序。

  • 或者,使用建议列表右下角的 按字母顺序排序按相关性排序 切换这些模式。 请注意,这些图标不会显示在仅包含少量条目的列表中。

在列表中包含区分大小写的建议

  • 选择 区分大小写 复选框,并选择是否仅匹配首字母大小写,或匹配所有字母大小写。

启用自动文档查阅

  1. 按下 Ctrl+Alt+S 打开设置,然后选择 编辑器 | 常规 | 代码完成

  2. 请选择 显示文档弹窗 复选框。

    了解更多信息,请参阅 基本补全:文档查阅

自动插入括号

  1. 按下 Ctrl+Alt+S 打开设置,然后选择 编辑器 | 常规 | 代码完成

  2. 请选择 在适用时自动插入括号 复选框。

    默认情况下,此选项已启用,WebStorm 在您完成函数/方法时会自动插入一对开闭括号。

    启用插入括号功能
    补全时插入括号已禁用

    取消选中该复选框以禁止自动插入括号。

  3. 如果您使用一个开括号 ( 而不是 Enter 从完成列表中应用选定项,那么无论该选项是否打开,括号都会自动插入。

    完成时插入括号已禁用。 在补全带有开括号的情况下,仍然会插入括号。

    要使用开括号 ( 而不是 Enter 来应用补全列表中的选定项,请选择 通过按空格、点或其他上下文相关键插入选定建议 复选框。 如需更多信息,请参阅 Use specific keys to insert suggestions

使用特定按键插入建议

  1. 按下 Ctrl+Alt+S 以打开设置,然后选择 编辑器 | 常规 | 代码完成

  2. 请选择 通过按空格、点或其他上下文相关键插入选定建议 复选框。 这些按键取决于调用补全的语言和上下文。

在 HTML 中抑制纯文本的补全

在 HTML 上下文中,WebStorm 默认即使在您输入纯文本而没有开尖括号时也会显示补全建议。

  • 要关闭此令人烦恼的行为,请打开 设置 对话框(Ctrl+Alt+S ),转到 编辑器 | 常规 | 代码完成 ,并清除 在 HTML 文本中输入时启用标签名称代码补全的自动弹出 复选框。

    抑制标签补全

基于机器学习排序建议

  1. 按下 Ctrl+Alt+S 以打开设置,然后选择 编辑器 | 常规 | 代码完成

  2. 默认情况下,JavaScript 和 TypeScript 文件中的补全建议根据机器学习算法按相关性排序。

    要关闭基于 ML 的排序,请清除 基于机器学习排序完成建议 复选框。

    要仅在 JavaScript 或 TypeScript 中关闭基于 ML 的排序,请清除相应的复选框。

  3. WebStorm 可以根据建议的相关性对其进行排序,并显示特殊标记以指示此排序。

    • 最相关的建议用星号 最相关建议图标 标记。 要显示此指示器,请选择 标记补全弹出窗口中最相关的项 复选框。

    • 机器学习排名提升机器学习排名降序 箭头图标指示建议的相关性是上升还是下降,因此建议在列表中上移或下移。

      要显示这些指示器,请选择 在补全弹出窗口中标记位置更改 复选框。

    显示相关性标记
    隐藏相关性标记

配置 JavaScript 的补全

除了通用的补全行为设置外,您还可以在 编辑器 | 常规 | 代码完成 页面上的 设置 对话框(Ctrl+Alt+S )中配置一些 JavaScript 特定选项。

  • WebStorm 会建议符号的补全,而不考虑其类型。 使用这种方法,在复杂情况下,列表会显示多个补全变体。

    要使补全更精确,请选择 仅基于类型的补全。 完成列表将很大程度上依赖于 WebStorm 推理。 因此,如果推理效果不佳,该列表可能会保持为空。

  • WebStorm 为带有 可选链操作符 (?) 的符号提供补全建议。

    要抑制此行为,请清除 针对可空类型建议使用可选链的条目 复选框。

  • 当您想要重写父类或接口中的方法并从补全建议列表中选择此方法时,WebStorm 会自动添加参数,生成 super() 调用,并在可能的情况下添加类型信息。

    清除 在重写的补全中展开方法主体 复选框以禁止在补全期间自动生成重写方法的主体。

  • 配置名称补全:

    1. 建议变量和参数名称 :默认情况下,复选框为空。 选中后,WebStorm 会在声明新类字段、变量和参数时建议名称。 这些建议是基于您的项目中定义的类、类型和接口的名称,您使用的库以及标准 API。

    2. 为类字段建议名称

      默认情况下,该选项处于关闭状态。

    3. 为建议的参数名称添加类型注解 :选中此复选框以提供每个完成建议的类型信息。

      仅当选中 建议变量和参数名称 复选框时,此复选框才可用。

  • 配置在检查或接受建议时如何显示参数信息。

    1. 显示参数信息弹出窗口(毫秒) :选择此复选框以使 WebStorm 在编辑器中键入左括号或从建议列表中选择方法时,自动显示包含所有可用方法签名的弹窗。

      在右侧的文本字段中,指定弹出窗口应出现的延迟时间(以毫秒为单位)。

      如果未选中此复选框,请从主菜单中选择 查看 | 参数信息

    2. 显示完整方法签名 :如果选中此复选框,参数信息将显示完整签名,包括方法名称和返回类型。

完成路径

此类补全加快了文件和文件夹的选择。 用于此目的的 对话框 被频繁调用,例如,当您指定外部工具或版本控制引擎的安装文件夹或配置 Node.js 解释器时。

  1. 通过在 文件 菜单中选择 打开文件 ,或单击路径字段旁边的 浏览 “浏览”按钮 ,打开 选择路径对话框

  2. 确保 路径 字段可见。 如果字段被隐藏,请单击 显示路径 链接。

  3. 开始输入路径。 WebStorm 会建议一个列表,您可以快速找到所需的目录。

    补全路径

    随着您的输入,建议列表会缩小范围,仅显示匹配的路径。

    您还可以按 Ctrl+Space 显示建议列表。

  4. 从列表中选择相关建议。

故障排除

如果代码补全不起作用,可能是以下原因之一:

  • 省电模式 在 (文件 | 省电模式)。 开启它可以通过消除后台操作(包括错误高亮、即时检查和代码补全)来最大限度地减少笔记本电脑的电量消耗。

  • 您的文件不在内容根目录中,因此无法获得代码补全所需的类定义和资源。

  • 用于代码补全的符号文件被 标记为纯文本文件

  • 用于代码补全的第三方符号文件未被 配置为外部 JavaScript 库

  • 如果收集代码补全选项花费的时间太长,代码补全弹出窗口可能不会自动出现。 例如,如果计算机正在忙于其他任务。 在这种情况下,您仍然可以通过 Ctrl+Space 手动激活代码补全弹出窗口。

最后修改日期: 2025年 12月 8日