Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
VisualStudio.Extensibility-Erweiterungen verwenden string-resources.json-Dateien für die Lokalisierung. Bei diesem Ansatz werden Befehlsanzeigenamen, QuickInfos und andere Erweiterungsmetadaten lokalisiert, die die Lokalisierung unterstützen.
Note
Der von VSSDK-Erweiterungen verwendete .vsixlangpack-Mechanismus wird für VisualStudio.Extensibility-Erweiterungen nicht unterstützt. Verwenden Sie stattdessen string-resources.json.
Funktionsweise der Lokalisierung
Eigenschaften mit Lokalisierungsunterstützung verwenden das Trennzeichen %, um auf Schlüssel für Zeichenfolgenressourcen zu verweisen. Der Compiler gibt eine Warnung aus, wenn diese Eigenschaften auf einen nicht lokalisierbaren Wert festgelegt sind. Um eine Zeichenfolge zu lokalisieren, umgeben Sie den Zeichenfolgenressourcenschlüssel mit den Zeichen %:
public override CommandConfiguration CommandConfiguration => new("%MyExtension.MyCommand.DisplayName%")
{
TooltipText = "%MyExtension.MyCommand.TooltipText%"
};
string-resources.json
Ihre Erweiterung sollte für jede Sprache, die von Ihrer Erweiterung unterstützt wird, eine string-resources.json-Datei bereitstellen. Diese JSON-Datei ist ein Wörterbuch aus Schlüssel-Wert-Paaren, wobei der Schlüssel eine global eindeutige Kennung für eine Zeichenfolgenressource und der Wert die lokalisierte Zeichenfolge ist.
Standard (Englisch) — .vsextension/string-resources.json:
{
"MyExtension.MyCommand.DisplayName": "My Command",
"MyExtension.MyCommand.TooltipText": "Runs my command"
}
Deutsch — .vsextension/de/string-resources.json:
{
"MyExtension.MyCommand.DisplayName": "Mein Befehl",
"MyExtension.MyCommand.TooltipText": "Führt meinen Befehl aus"
}
Verzeichnisstruktur
Stellen Sie die string-resources.json Dateien im .vsextension Verzeichnis bereit. Platzieren Sie eine Standarddatei in Stamm- und gebietsschemaspezifischen Dateien in Unterordnern, die durch Gebietsschemacode benannt sind:
.vsextension/
├── string-resources.json (default / fallback)
├── de/
│ └── string-resources.json (German)
├── es/
│ └── string-resources.json (Spanish)
├── fr/
│ └── string-resources.json (French)
└── ja/
└── string-resources.json (Japanese)
Das string-resources.json im Stammverzeichnis von .vsextension wird als Fallback verwendet, wenn Visual Studio auf eine Sprache eingestellt ist, für die Ihre Erweiterung keine lokalisierte Datei bereitstellt.
Lokalisieren von Laufzeit-UI-Zeichenfolgen
Der obige string-resources.json Ansatz deckt Erweiterungsmetadaten (Befehlsnamen, QuickInfos) ab, die Visual Studio automatisch lädt. Für Zeichenfolgen, die zur Laufzeit in der Benutzeroberfläche Ihrer Erweiterung angezeigt werden , z. B. Toolfensterbeschriftungen, Dialogtext oder Statusmeldungen – müssen Sie Übersetzungen selbst laden.
Empfohlener Ansatz: eingebettete JSON-Ressourcendateien
- Erstellen Sie gebietsspezifische JSON-Dateien in Ihrem Projekt (z. B.
Strings/en.json,Strings/de.json):
// Strings/en.json
{
"ToolWindow.Title": "My Tool Window",
"Status.Loading": "Loading project data...",
"Error.NotFound": "The requested item was not found."
}
- Markieren Sie sie als eingebettete Ressourcen in Ihrem
.csproj:
<ItemGroup>
<EmbeddedResource Include="Strings\*.json" />
</ItemGroup>
- Laden Sie zur Laufzeit die richtige Datei anhand der aktuellen Kultur:
using System.Globalization;
using System.Reflection;
using System.Text.Json;
public static class LocalizedStrings
{
private static readonly Dictionary<string, string> Strings = LoadStrings();
private static Dictionary<string, string> LoadStrings()
{
var culture = CultureInfo.CurrentUICulture.TwoLetterISOLanguageName;
var assembly = Assembly.GetExecutingAssembly();
// Try culture-specific, then fall back to English
var resourceName = $"MyExtension.Strings.{culture}.json";
var stream = assembly.GetManifestResourceStream(resourceName)
?? assembly.GetManifestResourceStream("MyExtension.Strings.en.json");
if (stream is null) return new();
using var reader = new StreamReader(stream);
return JsonSerializer.Deserialize<Dictionary<string, string>>(reader.ReadToEnd()) ?? new();
}
public static string Get(string key) =>
Strings.TryGetValue(key, out var value) ? value : key;
}
- Verwenden Sie das Hilfsprogramm in Ihrem Erweiterungscode:
// In a tool window, command handler, or dialog
var title = LocalizedStrings.Get("ToolWindow.Title");
Important
Mischen Sie die Metadatenlokalisierung (string-resources.json in .vsextension/) nicht mit der Lokalisierung von Laufzeitzeichenfolgen. Sie dienen verschiedenen Zwecken:
-
.vsextension/string-resources.json— vom VS-Host für Befehlsnamen und QuickInfos geladen - Eingebettete Ressourcendateien – geladen vom Erweiterungscode für UI-Strings
Tips
✅ DO
- Halten Sie Zeichenfolgenschlüssel global eindeutig und beschreibend.
- Stellen Sie immer eine englische Fallbackdatei bereit.
- Testen Sie mit einem nicht englischen, in Visual Studio installierten Sprachpaket.
- Verwenden Sie
CultureInfo.CurrentUICulturefür UI-Zeichenfolgen.
❌ NICHT
- Verwenden Sie keine generischen Schlüssel wie
"Label1". - Gehen Sie nicht davon aus, dass die Kultur des Nutzers immer mit einem vorgegebenen Gebietsschema übereinstimmt.
- Hartkodieren Sie keine für Benutzer sichtbaren Zeichenfolgen direkt im Code.
- Verwenden Sie
CultureInfo.CurrentCulturenicht für Benutzeroberflächenzeichenfolgen; dies ist für Zahlen- und Datumsformatierungen vorgesehen.