扩展指南

在 Hello World 示例中学习了 Visual Studio Code 扩展 API 的基础知识后，是时候构建一些实际的扩展了。尽管扩展功能部分提供了扩展可以做什么的概述，但本部分包含详细的代码指南和示例列表，解释了如何使用特定的 VS Code API。

在每个指南或示例中，你可以找到

详细注释的源代码。
展示示例扩展用法的 gif 或图像。
运行示例扩展的说明。
列出正在使用的 VS Code API。
列出正在使用的贡献点。
类似于示例的实际扩展。
API 概念解释。

指南与示例

以下是 VS Code 网站上的指南，包括它们对VS Code API 和贡献点的使用。别忘了参考用户体验指南，学习创建扩展的用户界面最佳实践。

VS Code 网站上的指南	API 和贡献
命令	commands contributes.commands
颜色主题	contributes.themes
文件图标主题	contributes.iconThemes
产品图标主题	contributes.productIconThemes
树状视图	window.createTreeView window.registerTreeDataProvider TreeView TreeDataProvider contributes.views contributes.viewsContainers
Webview	window.createWebviewPanel window.registerWebviewPanelSerializer
自定义编辑器	window.registerCustomEditorProvider CustomTextEditorProvider contributes.customEditors
虚拟文档	workspace.registerTextDocumentContentProvider commands.registerCommand window.showInputBox
虚拟工作区	workspace.fs capabilities.virtualWorkspaces
工作区信任	workspace.isTrusted workspace.onDidGrantWorkspaceTrust capabilities.untrustedWorkspaces
任务提供者	tasks.registerTaskProvider Task ShellExecution contributes.taskDefinitions
源代码管理	workspace.workspaceFolders SourceControl SourceControlResourceGroup scm.createSourceControl TextDocumentContentProvider contributes.menus
调试器扩展	contributes.breakpoints contributes.debuggers debug
Markdown 扩展	markdown.previewStyles markdown.markdownItPlugins markdown.previewScripts
测试扩展	TestController TestItem
自定义数据扩展	contributes.html.customData contributes.css.customData

以下是来自 VS Code Extensions 示例仓库的其他示例列表。

GitHub 仓库上的示例	API 和贡献
Webview 示例	window.createWebviewPanel window.registerWebviewPanelSerializer
状态栏示例	window.createStatusBarItem StatusBarItem
树状视图示例	window.createTreeView window.registerTreeDataProvider TreeView TreeDataProvider contributes.views contributes.viewsContainers
任务提供者示例	tasks.registerTaskProvider Task ShellExecution contributes.taskDefinitions
多根工作区示例	workspace.getWorkspaceFolder workspace.onDidChangeWorkspaceFolders
补全提供者示例	languages.registerCompletionItemProvider CompletionItem SnippetString
文件系统提供者示例	workspace.registerFileSystemProvider
编辑器装饰器示例	TextEditor.setDecorations DecorationOptions DecorationInstanceRenderOptions ThemableDecorationInstanceRenderOptions window.createTextEditorDecorationType TextEditorDecorationType contributes.colors
本地化示例
终端示例	window.createTerminal window.onDidChangeActiveTerminal window.onDidCloseTerminal window.onDidOpenTerminal window.Terminal window.terminals
Vim 示例	commands StatusBarItem window.createStatusBarItem TextEditorCursorStyle window.activeTextEditor Position Range Selection TextEditor TextEditorRevealType TextDocument
源代码管理示例	workspace.workspaceFolders SourceControl SourceControlResourceGroup scm.createSourceControl TextDocumentContentProvider contributes.menus
注释 API 示例
文档编辑示例	commands contributes.commands
入门示例	contributes.walkthroughs
测试扩展	TestController TestItem

语言扩展示例

这些是语言扩展示例

示例	VS Code 网站上的指南
代码片段示例	/api/language-extensions/snippet-guide
语言配置示例	/api/language-extensions/language-configuration-guide
LSP 示例	/api/language-extensions/language-server-extension-guide
LSP 日志流示例	不适用
LSP 多根工作区服务器示例	https://github.com/microsoft/vscode/wiki/Adopting-Multi-Root-Workspace-APIs#language-client--language-server (GitHub 仓库 Wiki)
LSP Web 扩展示例	/api/language-extensions/language-server-extension-guide

05/08/2025