vscode插件開發中文文檔教程(1)——擴展 API
原文鏈接:Extension API
作者:Microsoft
譯者:倔強青銅三
前言
大家好,我是倔強青銅三。是一名熱情的軟件工程師,我熱衷於分享和傳播IT技術,致力於通過我的知識和技能推動技術交流與創新,歡迎關注我,微信公眾號:倔強青銅三。歡迎點贊、收藏、關注,一鍵三連!!!
擴展 API
Visual Studio Code 是以可擴展性為核心設計的。從 UI 到編輯體驗,VS Code 的幾乎每個部分都可以通過擴展 API 進行自定義和增強。事實上,VS Code 的許多核心功能都是作為 擴展 構建的,並使用相同的擴展 API。
本文檔描述了以下內容:
- 如何構建、運行、調試、測試和發佈擴展
- 如何充分利用 VS Code 豐富的擴展 API
- 如何找到指南和代碼示例,幫助您快速上手
- 遵循我們的UX 指南獲取最佳實踐
代碼示例可在 Microsoft/vscode-extension-samples 找到。
如果您正在尋找已發佈的擴展,請訪問 VS Code 擴展市場。
擴展可以做什麼?
以下是使用擴展 API 可以實現的一些示例:
- 使用顏色或文件圖標主題更改 VS Code 的外觀 - 主題化
- 在 UI 中添加自定義組件和視圖 - 擴展工作台
- 創建一個 Webview 來顯示用 HTML/CSS/JS 構建的自定義網頁 - Webview 指南
- 支持一種新的編程語言 - 語言擴展概述
- 支持調試特定運行時 - 調試器擴展指南
如果您希望對擴展 API 有更全面的瞭解,請參考 擴展功能概述 頁面。擴展指南概述 還包含了一個代碼示例和指南列表,展示了各種擴展 API 的用法。
如何構建擴展?
構建一個優秀的擴展需要花費大量時間和精力。以下是 API 文檔中各部分內容如何幫助您:
- 入門 教授構建擴展的基本概念,使用 Hello World 示例。
- 擴展功能 將 VS Code 龐大的 API 分解為更小的類別,並指向更詳細的主題。
- 擴展指南 包含解釋 VS Code 擴展 API 特定用法的指南和代碼示例。
- UX 指南 展示在擴展中提供出色用户體驗的最佳實踐。
- 語言擴展 展示如何通過指南和代碼示例為編程語言添加支持。
- 測試與發佈 包括關於擴展開發主題(如測試和發佈擴展)的深入指南。
- 高級主題 解釋高級概念,例如 擴展主機、支持遠程開發和 GitHub Codespaces 和 提議的 API。
- 參考資料 包含詳盡的 VS Code API、貢獻點 和許多其他主題的參考。
有什麼新內容?
VS Code 每月更新一次,擴展 API 也是如此。每個月都會有新的功能和 API 發佈,以增強 VS Code 擴展的功能和範圍。
要隨時瞭解擴展 API 的最新動態,您可以查看每月的發佈説明,其中專門涵蓋了以下內容:
- 擴展開發 - 瞭解最新版本中可用的新擴展 API。
- 提議的擴展 API - 查看並反饋即將推出的提議 API。
需要幫助嗎?
如果您在擴展開發中有問題,可以嘗試在以下平台提問:
- VS Code 討論:GitHub 社區討論 VS Code 的擴展平台,提問、幫助社區其他成員並獲得答案。
- Stack Overflow:這裏有數千個問題標記為
vscode-extensions,其中一半以上已經有答案。搜索您的問題,提問,或者通過回答 VS Code 擴展開發相關問題來幫助其他開發者! - VS Code Dev Slack:擴展開發者的公共聊天室。VS Code 團隊成員經常參與討論。
要對文檔提供反饋,請在 Microsoft/vscode-docs 創建新問題。如果您有關於擴展的問題無法找到答案,或者遇到 VS Code 擴展 API 的問題,請在 Microsoft/vscode 提交新問題。
最後感謝閲讀!歡迎關注我,微信公眾號:倔強青銅三。歡迎點贊、收藏、關注,一鍵三連!!!