Extension API
Visual Studio Code ist auf Erweiterbarkeit ausgelegt. Von der Benutzeroberfläche bis zum Editor-Erlebnis kann fast jeder Teil von VS Code durch die Extension API angepasst und erweitert werden. Tatsächlich sind viele Kernfunktionen von VS Code als Erweiterungen erstellt und verwenden dieselbe Extension API.
Diese Dokumentation beschreibt
- Wie man eine Erweiterung erstellt, ausführt, debuggt, testet und veröffentlicht
- Wie man die umfangreiche Extension API von VS Code nutzt
- Wo man Anleitungen und Codebeispiele findet, um Ihnen den Einstieg zu erleichtern
- Die Befolgung unserer UX-Richtlinien für Best Practices
Codebeispiele sind unter Microsoft/vscode-extension-samples verfügbar.
Wenn Sie nach veröffentlichten Erweiterungen suchen, besuchen Sie den VS Code Extension Marketplace.
Was können Erweiterungen tun?
Hier sind einige Beispiele, was Sie mit der Extension API erreichen können
- Ändern Sie das Aussehen von VS Code mit einem Farb- oder Dateisymbol-Theme - Theming
- Fügen Sie benutzerdefinierte Komponenten & Ansichten in der Benutzeroberfläche hinzu - Erweiterung der Workbench
- Erstellen Sie ein Webview, um eine benutzerdefinierte Webseite anzuzeigen, die mit HTML/CSS/JS erstellt wurde - Webview-Anleitung
- Unterstützen Sie eine neue Programmiersprache - Übersicht über Sprach-Erweiterungen
- Unterstützen Sie das Debuggen einer bestimmten Laufzeitumgebung - Anleitung für Debugger-Erweiterungen
Wenn Sie einen umfassenderen Überblick über die Extension API wünschen, lesen Sie die Seite Übersicht über Erweiterungsfunktionen. Die Übersicht über Erweiterungsanleitungen enthält auch eine Liste von Codebeispielen und Anleitungen, die verschiedene Verwendungszwecke der Extension API veranschaulichen.
Wie erstellt man Erweiterungen?
Der Aufbau einer guten Erweiterung kann viel Zeit und Mühe kosten. Hier ist, wie Ihnen jeder Abschnitt der API-Dokumentation helfen kann
- Erste Schritte vermittelt grundlegende Konzepte für die Erstellung von Erweiterungen mit dem Hello World Beispiel.
- Erweiterungsfunktionen gliedert die umfangreiche API von VS Code in kleinere Kategorien und verweist Sie auf detailliertere Themen.
- Erweiterungsanleitungen enthalten Anleitungen und Codebeispiele, die spezifische Verwendungen der VS Code Extension API erläutern.
- UX-Richtlinien zeigen Best Practices für die Bereitstellung einer großartigen Benutzererfahrung in einer Erweiterung.
- Spracherweiterungen veranschaulichen, wie man Unterstützung für eine Programmiersprache mit Anleitungen und Codebeispielen hinzufügt.
- Testen und Veröffentlichen enthält detaillierte Anleitungen zu verschiedenen Themen der Erweiterungsentwicklung, wie z. B. das Testen und Veröffentlichen von Erweiterungen.
- Erweiterte Themen erläutern fortgeschrittene Konzepte wie den Erweiterungs-Host, Unterstützung für Remote-Entwicklung und GitHub Codespaces sowie die Vorgeschlagene API.
- Referenzen enthält umfassende Referenzen für die VS Code API, Beitragspunkte und viele andere Themen.
Was gibt's Neues?
VS Code wird monatlich aktualisiert, und das gilt auch für die Extension API. Jeden Monat werden neue Funktionen und APIs verfügbar, um die Leistungsfähigkeit und den Umfang von VS Code-Erweiterungen zu erhöhen.
Um über die Extension API auf dem Laufenden zu bleiben, können Sie die monatlichen Versionshinweise lesen, die spezielle Abschnitte enthalten zu
- Erstellung von Erweiterungen - Erfahren Sie, welche neuen Erweiterungs-APIs in der neuesten Version verfügbar sind.
- Vorgeschlagene Erweiterungs-APIs - Überprüfen Sie kommende vorgeschlagene APIs und geben Sie Feedback.
Hilfe suchen
Wenn Sie Fragen zur Entwicklung von Erweiterungen haben, versuchen Sie, diese auf folgenden Plattformen zu stellen:
- VS Code Diskussionen: GitHub-Community zum Austausch über die Erweiterungsplattform von VS Code, zum Stellen von Fragen, zur Hilfe für andere Mitglieder der Community und zum Erhalten von Antworten.
- Stack Overflow: Es gibt Tausende von Fragen mit dem Tag
vscode-extensions, und über die Hälfte davon hat bereits Antworten. Suchen Sie nach Ihrem Problem, stellen Sie Fragen oder helfen Sie Ihren Mitentwicklern, indem Sie Fragen zur VS Code-Erweiterungsentwicklung beantworten! - VS Code Dev Slack: Öffentlicher Chatraum für Erweiterungsentwickler. Mitglieder des VS Code-Teams nehmen oft an den Gesprächen teil.
Um Feedback zur Dokumentation zu geben, erstellen Sie neue Issues unter Microsoft/vscode-docs. Wenn Sie Fragen zu Erweiterungen haben, auf die Sie keine Antwort finden, oder Probleme mit der VS Code Extension API, öffnen Sie bitte neue Issues unter Microsoft/vscode.