WebStorm 2025.2 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 部分中，选择 建议变量与参数名称 和 建议类字段名称 复选框。

    如适用，可启用对建议参数名称显示类型注解。

    启用新符号名称建议

JavaScript 中来自 TypeScript 语言服务的补全

您可以通过使用来自 TypeScript 语言服务 的建议增强 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 补全机制不会添加任何新元素，而是对从代码中检索到的元素进行排序。 数据不会公开传输，只会在本地收集。

启用机器学习补全排序

  1. 按 Ctrl+Alt+S 打开设置，并选择 编辑器 | 常规 | 代码补全。

  2. 在 机器学习辅助补全 中，启用 根据机器学习对补全建议进行排序 选项并选择要使用 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 来应用补全列表中的所选项，请选中 通过按空格、点或其他上下文相关键插入选定建议 复选框。 有关详细信息，请参阅 使用特定按键插入建议。

使用特定按键插入建议

  1. 按 Ctrl+Alt+S 打开设置，然后选择 编辑器 | 常规 | 代码补全。

  2. 选择 按空格、点或其他依上下文而定的按键插入所选建议 复选框。 这些按键取决于所使用的语言及调用补全过程中的上下文环境。

禁止在 HTML 中对纯文本进行补全

在 HTML 上下文中，即使输入不带左尖括号的纯文本，WebStorm 默认也会显示补全建议。

  • 要关闭此令人困扰的行为，请打开 设置 对话框（Ctrl+Alt+S ），转到 编辑器 | 常规 | 代码补全 并取消选中 在 HTML 文本中键入时启用标签名称代码补全的自动弹出 复选框。

    禁止标签补全

基于机器学习对建议进行排序

  1. 按 Ctrl+Alt+S 打开设置，然后选择 编辑器 | 常规 | 代码补全。

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

    要关闭基于机器学习的排序，请取消选中 基于机器学习对补全部件建议排序 复选框。

    要仅在 JavaScript 或 TypeScript 中关闭基于机器学习的排序，请取消选中对应的复选框。

  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. 从列表中选择相关建议。

故障排除

如果代码补全功能无法使用，可能原因如下：

  • 省电模式 已启用（文件 | 省电模式）。 启用该功能可以通过停止后台操作（包括错误高亮、即时检查和代码补全）来降低笔记本电脑的功耗。

  • 您的文件不在 content root 中，因此无法获取代码补全所需的类定义和资源。

  • 用于代码补全的符号所在的文件已 标记为纯文本文件。

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

  • 如果收集补全选项的时间过长，则代码补全弹窗可能不会自动显示。 例如，当计算机正在处理其他任务时。 在这种情况下，您仍然可以通过 Ctrl+Space 手动激活补全弹窗。

最后修改日期： 2025年 9月 26日
生成代码整行代码补全