Mit diesem Formular können Sie fehlende, unklare oder fehlerhafte Inhalte in der Dokumentation melden und Verbesserungsvorschläge machen. Ihr Feedback hilft uns, die Qualität und Vollständigkeit kontinuierlich zu verbessern.
Visual Studio Code und der Workspace
Spracheinstellung
Visual Studio Code wird generell auf Englisch eingestellt. Dazu die Kommandopalette öffnen und Configure Display Language eingeben. Hier öffnet sich ein Editorfenster, in dem die Konfigurationsdatei wie folgt angepasst werden muss:
{
"locale":"en"
}
Der Grund für diese Einstellung ist zum einen das Visual Studio Code nicht an allen Stellen wirklich sauber auf Deutsch übersetzt ist. Zum anderen finden sich alle Dokumentationen, Blogbeiträge, etc. online nur auf Englisch und die Nutzung solcher Informationen ist deutlich einfacher wenn man als Anwender nicht selber jeweils gedanklich übersetzen muss.
Der Workspace des Projekts
Die Entwicklung von Extensions findet in einem Visual Studio Code Workspace statt. Allgemeine Informationen und umfassende Dokumentation dazu finden sich z. B. hier: https://code.visualstudio.com/docs/editor/multi-root-workspaces
Im Folgenden daher nur eine knappe Einführung:
Arbeiten mit einem "Multi-root Workspace"
Die grundsätzliche Arbeitsweise von Visual Studio Code besteht darin immer genau einen Quellordner zu öffnen. Es können dann die Dateien und Unterordner innerhalb dieses Ordners bearbeitet werden. Das Feature "Multi-root Workspace" ermöglicht es gleichzeitig mit mehreren Projektordnern (=Dateiordnern) in einer VS-Code-Session zu arbeiten. Das ist sehr nützlich für die Bearbeitung von zusammenhängenden Projekten. Es ist damit u. a. möglich mit gemeinsamen Grundeinstellungen zu arbeiten die für alle Projektordner gemeinsam gelten. Ohne diese Möglichkeit müssten diese Einstellungen jeweils in jedem Projektorder replizieren.
Ordner hinzufügen
Um Ordner zu einem Workspace hinzuzufügen wählt man File -> Add Folder to Workspace und wählt dann den hinzuzufügenden Ordner aus. Mit diesem Schritt kann man einen neuen Workspace erstellen, sofern man noch nicht in einem Workspace arbeitet. Wenn man bereits in einem Workspace arbeitet wird dieser um den Ordner erweitert.
Danach sieht man den hinzugefügten Ordner sofort im File Explorer.
Workspace Konfigurationsdatei
Die Datei an sich ist eine json Datei die alle Einstellungen einschließlich den Pfaden der enthaltenen Ordner enthält. Um die Einstellungen zu bearbeiten kann man entweder direkt die Konfigurationsdatei öffnen oder über die Kommandopalette Open Workspace Configuration File aufrufen.
Der Workspace im Kundenprojekt
Jedes Kundenprojekt wird mit einem Workspace initiiert. Dafür wird ein Template verwendet, welches zentral vorgehalten wird.
Der Workspace befindet sich im git Repository des Projekts im Stammverzeichnis. Der Dateiname ist project.code-workspace. Zentrale Einstellungen sind typischerweise im Workspace hinterlegt. Diese Einstellungen sind zentral festgelegt und dürfen nicht im Alltag mit persönlichen Einstellungen des Entwicklers übersteuert werden.
Im Workspace befindet sich eine Datei, aus der die Version des Workspace abgelesen werden kann: extensions/.resources/config/Version.json. Das Workspace-Template muss gelegentlich angepasst werden und die Information über die Template-Version ist für Troubleshooting rund um Skripte und Grundeinstellungen relevant.
Gemeinsame Ressourcen
Einer der Ordner im Workspace ist .resources. Dort befinden sich zentrale Dateien die allen Extensions für deren Entwicklung zur Verfügung stehen. Initial ist dort auch das einheitliche Logo für alle Extensions abgelegt.
Vorgegebene Extensions
Über den Workspace werden eine Reihe von Visual Studio Code Extensions verwaltet, die für die Entwicklung erforderlich sind. Bei jedem Öffnen des Workspace werden diese Extensions mit den installierten Extensions abgeglichen. Fehlende Extensions werden daraufhin zum Installieren vorgeschlagen. Es ist technisch nicht möglich die Installation zu erzwingen, aber diese Extensions müssen für die Entwicklung von Extensions installiert werden.
Empfohlene persönliche Einstellungen
Zuzüglich zu den Einstellungen die mit dem Workspace obligatorisch gesetzt werden, ist es empfehlenswert eine Reihe persönlicher Einstellungen festzulegen. Die folgende Auswahl gibt einige wichtige Einstellungen wieder, ohne den Anspruch auf Vollständigkeit.
| files.autosave | "off", "afterDelay", "onFocusChange", "onWindowChange" | Es kann sehr komfortabel sein Änderungen an Dateien automatisch zu speichern. Entweder zeitgesteuert oder entweder mit Änderungen des Fokus weg vom Editor oder weg von Visual Studio Code |
| files.AutoSaveDelay | z. B. 1000ms | Nur gültig wenn files.autosave auf "afterDelay" steht -> legt die Zeit zwischen einer Änderung und dem Speichern fest |
| workbench.iconTheme | "vscode-icons" | Erfordert die Extension "vscode-icons". Bessere Navigation durch Icons im File Explorer |
| editor.minimap.enabled | true oder false | Entfernt die Code Minimap im Editor, stört manche Entwickler, weil das Platz auf dem Bildschirm kostet |
Die persönlichen Einstellungen werden erreicht über File -> Preferences -> Settings.