Visual Studio Code 中的 JavaScript

Visual Studio Code 包括内置的 JavaScript IntelliSense、调试、格式化、代码导航、重构以及许多其他高级语言功能。

大多数这些功能开箱即用，而有些功能可能需要基本配置才能获得最佳体验。此页面总结了 VS Code 附带的 JavaScript 功能。来自 VS Code 市场的扩展可以增强或更改大多数这些内置功能。有关这些功能如何工作以及如何配置的更深入指南，请参阅使用 JavaScript。

IntelliSense

IntelliSense 向您显示智能代码补全、悬停信息和签名信息，以便您可以更快、更正确地编写代码。

VS Code 在您的 JavaScript 项目中提供 IntelliSense；对于许多 npm 库（例如 React、lodash 和 express）；以及对于其他平台（例如 node、serverless 或 IoT）。

有关 VS Code 的 JavaScript IntelliSense、如何配置它以及帮助解决常见 IntelliSense 问题的更多信息，请参阅使用 JavaScript。

JavaScript 项目 (jsconfig.json)

jsconfig.json 文件在 VS Code 中定义 JavaScript 项目。虽然不是必须使用 jsconfig.json 文件，但在以下情况下，您可能需要创建一个：

• 如果并非工作区中的所有 JavaScript 文件都应被视为单个 JavaScript 项目的一部分。jsconfig.json 文件允许您排除某些文件不显示在 IntelliSense 中。
• 确保工作区中 JavaScript 文件的子集被视为单个项目。如果您正在使用使用隐式全局依赖项而不是 imports 进行依赖项管理的旧代码，这将非常有用。
• 如果您的工作区包含多个项目上下文，例如前端和后端 JavaScript 代码。对于多项目工作区，请在每个项目的根文件夹中创建一个 jsconfig.json。
• 您正在使用 TypeScript 编译器来降级编译 JavaScript 源代码。

要定义基本的 JavaScript 项目，请在工作区的根目录中添加一个 jsconfig.json

{
  "compilerOptions": {
    "module": "CommonJS",
    "target": "ES6"
  },
  "exclude": ["node_modules"]
}

有关更高级的 jsconfig.json 配置，请参阅使用 JavaScript。

代码片段

VS Code 包括基本的 JavaScript 代码片段，这些代码片段在您键入时会建议；

有许多扩展提供了额外的代码片段，包括用于流行框架（如 Redux 或 Angular）的代码片段。您甚至可以定义您自己的代码片段。

JSDoc 支持

VS Code 理解许多标准的 JSDoc 注释，并使用这些注释来提供丰富的IntelliSense。您可以选择甚至使用来自 JSDoc 注释的类型信息来类型检查您的 JavaScript。

通过在函数声明之前键入 /** 并选择JSDoc 注释代码片段建议，快速为函数创建 JSDoc 注释

要禁用 JSDoc 注释建议，请设置 "javascript.suggest.completeJSDocs": false。

悬停信息

将鼠标悬停在 JavaScript 符号上以快速查看其类型信息和相关文档。

⌘K ⌘I (Windows、Linux Ctrl+K Ctrl+I) 键盘快捷键在当前光标位置显示此悬停信息。

签名帮助

当您编写 JavaScript 函数调用时，VS Code 会显示有关函数签名的信息，并突出显示您当前正在完成的参数

当您在函数调用中键入 ( 或 , 时，会自动显示签名帮助。按 ⇧⌘Space (Windows、Linux Ctrl+Shift+Space) 手动触发签名帮助。

自动导入

自动导入通过建议整个项目及其依赖项中的可用变量来加速编码。当您选择其中一个建议时，VS Code 会自动为其在文件顶部添加导入。

只需开始键入即可查看当前项目中所有可用 JavaScript 符号的建议。自动导入建议显示它们的导入来源

如果您选择其中一个自动导入建议，VS Code 会为其添加导入。

在此示例中，VS Code 从 material-ui 为 Button 添加导入到文件顶部

要禁用自动导入，请将 "javascript.suggest.autoImports" 设置为 false。

粘贴时添加导入

当您在编辑器之间复制和粘贴代码时，VS Code 可以在粘贴代码时自动添加导入。当您粘贴包含未定义符号的代码时，会显示粘贴控件，让您可以在粘贴为纯文本或添加导入之间进行选择。

此功能默认启用，但您可以通过切换 javascript.updateImportsOnPaste.enabled 设置来禁用它。

您可以通过配置 editor.pasteAs.preferences 设置，使粘贴时导入成为默认行为，而无需显示粘贴控件。包括 text.updateImports.jsts 或 text.updateImports 以在粘贴时始终添加导入。

组织导入

组织导入源操作对 JavaScript 文件中的导入进行排序，并删除任何未使用的导入

您可以从源操作上下文菜单或使用 ⇧⌥O (Windows、Linux Shift+Alt+O) 键盘快捷键运行组织导入。

您还可以通过设置在保存 JavaScript 文件时自动执行组织导入

"editor.codeActionsOnSave": {
    "source.organizeImports": "explicit"
}

在文件移动时更新导入

当您移动或重命名 JavaScript 项目中其他文件导入的文件时，VS Code 可以自动更新引用移动文件的所有导入路径

javascript.updateImportsOnFileMove.enabled 设置控制此行为。有效设置值为：

• "prompt" - 默认值。询问是否应为每个文件移动更新路径。
• "always" - 始终自动更新路径。
• "never" - 不要自动更新路径，也不要提示。

格式化

VS Code 的内置 JavaScript 格式化程序提供具有合理默认设置的基本代码格式化。

javascript.format.* 设置配置内置格式化程序。或者，如果内置格式化程序妨碍了您，请将 "javascript.format.enable" 设置为 false 以禁用它。

对于更专业的代码格式化样式，请尝试从 市场安装 JavaScript 格式化扩展之一。

JSX 和自动关闭标签

VS Code 的所有 JavaScript 功能也适用于 JSX

您可以在普通的 *.js 文件和 *.jsx 文件中使用 JSX 语法。

VS Code 还包括 JSX 特定的功能，例如 JSX 标签的自动关闭

将 "javascript.autoClosingTags" 设置为 false 以禁用 JSX 标签关闭。

代码导航

代码导航使您可以快速导航 JavaScript 项目。

• 转到定义 F12 - 转到符号定义的源代码。
• 速览定义 ⌥F12 (Windows Alt+F12, Linux Ctrl+Shift+F10) - 调出一个“速览”窗口，显示符号的定义。
• 转到引用 ⇧F12 (Windows、Linux Shift+F12) - 显示符号的所有引用。
• 转到类型定义 - 转到定义符号的类型。对于类的实例，这将显示类本身，而不是实例定义的位置。

您可以使用命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中的转到符号命令通过符号搜索进行导航。

• 转到文件中的符号 ⇧⌘O (Windows、Linux Ctrl+Shift+O)
• 转到工作区中的符号 ⌘T (Windows、Linux Ctrl+T)

重命名

按 F2 重命名光标下的符号在您的 JavaScript 项目中

重构

VS Code 包括一些方便的 JavaScript 重构，例如提取函数和提取常量。只需选择您要提取的源代码，然后单击装订线中的灯泡或按 (⌘. (Windows、Linux Ctrl+.)) 以查看可用的重构。

可用的重构包括：

• 提取到方法或函数。
• 提取到常量。
• 在命名导入和命名空间导入之间转换。
• 移动到新文件。

有关重构以及如何为单个重构配置键盘快捷键的更多信息，请参阅重构。

此外，默认情况下启用代码操作小组件：包括附近的快速修复 (editor.codeActionWidget.includeNearbyQuickFixes) 设置，这将从 ⌘. (Windows、Linux Ctrl+.) (命令 ID editor.action.quickFix) 激活行中最接近的快速修复，无论您的光标在该行中的哪个位置。

该命令突出显示将通过快速修复重构或修复的源代码。普通代码操作和非修复重构仍然可以在光标位置激活。

未使用的变量和无法访问的代码

未使用的 JavaScript 代码（例如，始终为真的 if 语句的 else 块或未引用的导入）在编辑器中会淡出

您可以通过将光标放在其上并触发快速修复命令 (⌘. (Windows、Linux Ctrl+.)) 或单击灯泡来快速删除此未使用的代码。

要禁用未使用的代码的淡出，请将 "editor.showUnused" 设置为 false。您还可以通过设置仅禁用 JavaScript 中未使用的代码的淡出

"[javascript]": {
    "editor.showUnused":  false
},
"[javascriptreact]": {
    "editor.showUnused":  false
},

保存时代码操作

editor.codeActionsOnSave 设置允许您配置在保存文件时运行的一组代码操作。例如，您可以通过设置在保存时启用组织导入

// On explicit save, run fixAll source action. On auto save (window or focus change), run organizeImports source action.
"editor.codeActionsOnSave": {
    "source.fixAll": "explicit",
    "source.organizeImports": "always",
}

截至今天，支持以下枚举：

• explicit（默认）：在显式保存时触发代码操作。与 true 相同。
• always：在显式保存以及窗口或焦点更改时的自动保存时触发代码操作。
• never：从不触发保存时代码操作。与 false 相同。

您还可以将 editor.codeActionsOnSave 设置为要按顺序执行的代码操作数组。

以下是一些源操作：

• "organizeImports" - 在保存时启用组织导入。
• "fixAll" - 保存时自动修复计算一轮中的所有可能的修复（适用于包括 ESLint 在内的所有提供程序）。
• "fixAll.eslint" - 仅对 ESLint 自动修复。
• "addMissingImports" - 在保存时添加所有缺少的导入。

有关更多信息，请参阅Node.js/JavaScript。

代码建议

VS Code 会自动建议一些常见的代码简化，例如将 promise 上的 .then 调用链转换为使用 async 和 await

将 "javascript.suggestionActions.enabled" 设置为 false 以禁用建议。

使用 AI 增强补全

GitHub Copilot 是一款 AI 驱动的代码补全工具，可帮助您更快、更智能地编写代码。您可以在 VS Code 中使用 GitHub Copilot 扩展来生成代码，或从它生成的代码中学习。

GitHub Copilot 为多种语言和各种框架提供建议，并且在 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++ 中尤其有效。

您可以在Copilot 文档中了解有关如何开始使用 Copilot 的更多信息。

安装并启用 Copilot 扩展后，您可以为您的 JavaScript 项目测试它。

创建一个新文件 - 您可以使用命令面板 (F1) 中的文件：新建文件命令。

在 JavaScript 文件中，键入以下函数标头

function calculateDaysBetweenDates(begin, end) {

Copilot 将提供如下建议 - 使用 Tab 接受建议

内嵌提示

内嵌提示将额外的内联信息添加到源代码，以帮助您理解代码的作用。

参数名称内嵌提示显示函数调用中参数的名称

这可以帮助您一目了然地了解每个参数的含义，这对于采用布尔标志或具有容易混淆的参数的函数尤其有用。

要启用参数名称提示，请设置 javascript.inlayHints.parameterNames。有三个可能的值：

• none — 禁用参数内嵌提示。
• literals — 仅显示文字（字符串、数字、布尔值）的内嵌提示。
• all — 显示所有参数的内嵌提示。

变量类型内嵌提示显示没有显式类型注释的变量的类型。

设置：javascript.inlayHints.variableTypes.enabled

属性类型内嵌提示显示没有显式类型注释的类属性的类型。

设置：javascript.inlayHints.propertyDeclarationTypes.enabled

参数类型提示显示隐式类型参数的类型。

设置：javascript.inlayHints.parameterTypes.enabled

返回类型内嵌提示显示没有显式类型注释的函数的返回类型。

设置：javascript.inlayHints.functionLikeReturnTypes.enabled

引用 CodeLens

JavaScript 引用 CodeLens 显示类、方法、属性和导出的对象的内联引用计数

要启用引用 CodeLens，请将 "javascript.referencesCodeLens.enabled" 设置为 true。

单击引用计数以快速浏览引用列表

代码检查器

代码检查器为可疑的代码提供警告。虽然 VS Code 不包含内置的 JavaScript 代码检查器，但市场中提供了许多 JavaScript 代码检查器扩展。

类型检查

您也可以在常规 JavaScript 文件中利用 TypeScript 的一些高级类型检查和错误报告功能。这是捕获常见编程错误的好方法。这些类型检查还为 JavaScript 启用了一些令人兴奋的快速修复，包括添加缺少的导入和添加缺少的属性。

TypeScript 尝试以与在 .ts 文件中相同的方式推断 .js 文件中的类型。当无法推断类型时，可以使用 JSDoc 注释显式指定它们。您可以在使用 JavaScript中阅读有关 TypeScript 如何使用 JSDoc 进行 JavaScript 类型检查的更多信息。

JavaScript 的类型检查是可选的并且是选择加入的。现有的 JavaScript 验证工具（如 ESLint）可以与内置的类型检查功能一起使用。

调试

VS Code 为 JavaScript 提供了出色的调试支持。设置断点、检查对象、导航调用堆栈以及在调试控制台中执行代码。请参阅调试主题以了解更多信息。

调试客户端

您可以使用浏览器调试器（例如我们内置的 Edge 和 Chrome 调试器）或 Debugger for Firefox 调试您的客户端代码。

调试服务器端

在 VS Code 中使用内置调试器调试 Node.js。设置很简单，并且有一个Node.js 调试教程可以帮助您。

常用扩展

VS Code 出厂时对 JavaScript 提供了出色的支持，但您还可以通过扩展安装调试器、代码片段、代码检查器和其他 JavaScript 工具。

后续步骤

继续阅读以了解：

• 使用 JavaScript - 有关 VS Code 的 JavaScript 支持以及如何解决常见问题的更详细信息。
• jsconfig.json - jsconfig.json 项目文件的详细描述。
• IntelliSense - 了解有关 IntelliSense 的更多信息以及如何有效地将其用于您的语言。
• 调试 - 了解如何为您的应用程序设置调试。
• Node.js - 创建 Express Node.js 应用程序的演练。
• TypeScript - VS Code 对 TypeScript 提供了出色的支持，TypeScript 为您的 JavaScript 代码带来了结构和强类型。

常见问题

VS Code 是否支持 JSX 和 React Native？

VS Code 支持 JSX 和 React Native。您将从 npmjs 类型声明文件存储库自动下载的类型声明（类型定义）文件中获得 React/JSX 和 React Native 的 IntelliSense。此外，您可以从市场安装流行的 React Native 扩展。

要为 React Native 启用 ES6 导入语句，您需要将 allowSyntheticDefaultImports 编译器选项设置为 true。这告诉编译器创建合成默认成员，您将获得 IntelliSense。React Native 在幕后使用 Babel 来创建具有默认成员的适当运行时代码。如果您还想调试 React Native 代码，您可以安装 React Native 扩展。

VS Code 是否支持 Dart 编程语言和 Flutter 框架？

是的，Dart 和 Flutter 开发都有 VS Code 扩展：Dart 和 Flutter。您可以在 Flutter.dev 文档中了解更多信息。

IntelliSense 不适用于外部库

Automatic Type Acquisition 适用于 npm（在 package.json 中指定）、Bower（在 bower.json 中指定）下载的依赖项，以及文件夹结构中列出的许多最常见的库（例如 jquery-3.1.1.min.js）。

ES6 样式导入不起作用。

当您想使用 ES6 样式导入，但某些类型声明（类型定义）文件尚未使用 ES6 样式导出时，请将 TypeScript 编译器选项 allowSyntheticDefaultImports 设置为 true。

{
  "compilerOptions": {
    "module": "CommonJS",
    "target": "ES6",
    // This is the line you want to add
    "allowSyntheticDefaultImports": true
  },
  "exclude": ["node_modules", "**/node_modules/*"]
}

我可以调试缩小/丑化的 JavaScript 吗？

是的，您可以。您可以在Node.js 调试主题中使用 JavaScript 源代码映射来查看其工作原理。

当使用非 ES6 构造时，如何禁用语法验证？

一些用户希望使用像提议的管道运算符 (|>) 这样的语法结构。 但是，VS Code 的 JavaScript 语言服务目前不支持这些结构，并将其标记为错误。 对于仍然希望使用这些未来特性的用户，我们提供了 javascript.validate.enable 设置。

通过将 javascript.validate.enable 设置为 false，您将禁用所有内置语法检查。 如果您这样做，我们建议您使用像 ESLint 这样的代码检查工具来验证您的源代码。

我可以使用像 Flow 这样的其他 JavaScript 工具吗？

是的，但是 Flow 的一些语言特性，例如类型和错误检查，可能会与 VS Code 的内置 JavaScript 支持相互干扰。 要了解如何禁用 VS Code 的内置 JavaScript 支持，请参阅 禁用 JavaScript 支持。