Richtlinien zum Formatieren von Text

2025-05-03

Die konsistente und angemessene Verwendung von Fett-, Kursiv- und Codeformatierungen von Textelementen verbessert die Lesbarkeit und hilft bei der Vermeidung von Missverständnissen. Wenn ein Textformatierungselement nicht von diesem Leitfaden abgedeckt wird, lesen Sie das Microsoft Writing Style Guide.If a text formatting element isn't covered by this guidance, refer to the Microsoft Writing Style Guide. Die folgenden Artikel enthalten detaillierte Anleitungen zur Textformatierung:

UI-Elemente

UI-Elemente wie Menüelemente, Dialogfeldernamen und Namen von Textfeldern sollten fett formatiert sein.

Dies: Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf den Projektknoten, und wählen Sie dann "Hinzufügen>Neues Element" aus.
Falsch: Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf den Projektknoten, und wählen Sie dann „Hinzufügen“ > „Neues Element“ aus.

Git-Repository- und Branch-Namen

Verwenden Sie fett formatierten Text für Git-Repository- oder Branch-Namen, wenn sie in Anweisungen ausgewählt oder eingegeben werden.

Dies: Wählen Sie im Verzweigungsmenü main aus.
Nicht dies: Wählen Sie im Branch-Menü "main" aus.

Neue Begriffseinführungen

Verwenden Sie kursiv formatierten Text, um einen neuen Begriff zusammen mit einer Definition oder Erklärung einzuführen. Kursivisieren Sie den neuen Begriff beim ersten Verwenden, und verwenden Sie dann regulären Text für die Definition oder Erläuterung.

Richtig: In App Service wird eine App in einem App Service-Plan ausgeführt. Mit einem App Service-Plan werden mehrere Computeressourcen definiert, auf denen eine Web-App ausgeführt wird.
Falsch: In App Service wird eine App in einem „App Service-Plan“ ausgeführt. Mit einem App Service-Plan werden Computeressourcen definiert, auf denen eine Web-App ausgeführt werden kann.

Codeformat

Verwenden Sie das Codeformat für Folgendes:

Codeelemente, z.B. Methodennamen, Eigenschaftennamen und Schlüsselwörter.
SQL-Befehle
NuGet-Paketnamen
Befehlszeilenbefehle*
Datenbanktabellennamen und Datenbankspaltennamen
Ressourcennamen, die nicht lokalisiert werden sollten (z. B. die Namen virtueller Computer)
URLs, die nicht klickbar sein sollen

Warum? Einige Stilrichtlinien schreiben vor, dass viele dieser Textelemente fett dargestellt werden. Weil aber die meisten Artikel lokalisiert werden, zeigt das Codeformat dem Übersetzer/der Übersetzerin, dass dieser Teil des Texts nicht übersetzt wird.

Das Codeformat kann inline sein (eingeschlossen in `) oder aus umgrenzten Codeblöcken bestehen (eingeschlossen in ```), die sich über mehrere Zeilen erstrecken. Fügen Sie längere Codeausschnitte und -pfade in umgrenzte Codeblöcke ein.

* Verwenden Sie in Befehlszeilenbefehlen Schrägstriche in Dateipfaden, wenn sie auf allen Plattformen unterstützt werden. Verwenden Sie umgekehrte Schrägstriche, um Befehle zu veranschaulichen, die auf Windows ausgeführt werden, wenn nur umgekehrte Schrägstriche unterstützt werden. Beispielsweise funktionieren Schrägstriche in der .NET-CLI auf allen Plattformen, sodass Sie dotnet build foldername/filename.csproj anstelle von dotnet build foldername\filename.csproj verwenden würden.

Beispiele für die Verwendung von Inlineformaten

Richtig: Standardmäßig interpretiert das Entity Framework eine Eigenschaft mit dem Namen Id oder ClassnameID als Primärschlüssel.
Falsch: Standardmäßig interpretiert das Entity Framework eine Eigenschaft mit dem Namen Id oder ClassnameID als Primärschlüssel.
Richtig: Das Paket Microsoft.EntityFrameworkCore enthält Runtime-Unterstützung für EF Core.
Falsch: Das Paket Microsoft.EntityFrameworkCore enthält Runtime-Unterstützung für EF Core.

Beispiele für umgrenzte Codeblöcke

Richtig: Es werden keine Befehle von Anweisungen, die nur IQueryable ändern, an die Datenbank gesendet, wie z.B. im folgenden Code:
```
    ```csharp
    var students = context.Students.Where(s => s.LastName == "Davolio")
    ```
```
Falsch: Es werden keine Befehle von Anweisungen, die nur IQueryable ändern, an die Datenbank gesendet, z. B. var students = context.Students.Where(s => s.LastName == "Davolio").
Richtig: Um beispielsweise das Skript Get-ServiceLog.ps1 im Verzeichnis C:\Scripts auszuführen, geben Sie Folgendes ein:
```
    ```powershell
    C:\Scripts\Get-ServiceLog.ps1
    ```
```
Falsch: Um beispielsweise das Skript Get-ServiceLog.ps1 im Verzeichnis C:\Scripts auszuführen, geben Sie Folgendes ein: „C:\Scripts\Get-ServiceLog.ps1“.
Alle umgrenzten Codeblöcke müssen ein genehmigtes Sprachtag haben. Eine Liste von unterstützten Sprachtags finden Sie unter Einbinden von Code in Dokumenten.

Platzhalter

Verwenden Sie in Absatztext oder Verfahrensschritten kursiv für Platzhaltertext, den Benutzer durch ihre eigenen Informationen ersetzen.

Dies: Kennwort eingeben
Nicht dies: Geben Sie "Kennwort" ein.
Dies: Geben Sie das Passwort-p ein
Nicht dies: Geben Sie das Kennwort "-p " ein.

Wenn der Benutzer einen Teil einer Eingabezeichenfolge durch eigene Werte ersetzen soll, verwenden Sie Platzhaltertext, der durch eckige Klammern markiert ist (Kleiner-als- < und Größer-als-Zeichen >).

Option 1: Verwenden Sie Codeformatierungen, um das Platzhalterwort oder den umgebenden Ausdruck einzuschließen. Sie können z. B. einzelne Graviszeichen ` für die Inlinecodeformatierung für einen einzelnen Ausdruck oder drei Graviszeichen ``` für die Formatierung mit Codefencing verwenden.

`az group delete -n <ResourceGroupName>`

Gerendert:

az group delete -n <ResourceGroupName>

oder

Option 2: Verwenden Sie einen umgekehrten Schrägstrich \ als Escapezeichen für die spitzen Klammern in Markdown, z. B. \< und \>. Während nur das erste Escapezeichen in der linken spitzen Klammer \< erforderlich ist, ist es aus Gründen der Konsistenz auch möglich, für die schließende Klammer \> ein Escapezeichen zu verwenden. Im gerenderten HTML-Code sieht der Leser das Escapezeichen nicht:

az group delete -n \<ResourceGroupName\>

Gerendert:

az group delete -n <ResourceGroupName>

Informieren Sie den Leser über den Platzhalter: Erläutern Sie im Text, der Platzhalterbeispielen vorangeht, dem Leser, dass der Text in eckigen Klammern entfernt und durch reale Werte ersetzt werden muss. Es wird empfohlen, Benutzereingaben kursiv zu formatieren. Sie können die Kursivformatierung innerhalb von Inlinecode in spitzen Klammern verwenden:

Ersetzen Sie im folgenden Beispiel den Platzhaltertext <ResourceGroupName> durch ihren eigenen Ressourcengruppennamen.

Achtung

Auf der Microsoft Learn-Website wird kein <Platzhaltertext> gerendert, der spitze Klammern verwendet, wenn die Klammern nicht ordnungsgemäß mit Escapezeichen versehen sind oder der Text nicht als Code formatiert ist. Der Microsoft Learn-Buildprozess interpretiert den <Platzhalterausdruck> als HTML-Tag, was beim Browser des Lesers zu Problemen führen kann, und kennzeichnet ihn als disallowed-html-tag. Im Buildbericht wird ein Vorschlag angezeigt, und das Platzhalterwort wird in diesem Fall nicht in der Ausgabe der Microsoft Learn-Seite gerendert.

Damit bei Platzhaltern keine Inhalte verloren gehen, verwenden Sie die code-Formatierung oder Escapezeichen (\<\>), wie weiter oben beschrieben.

Es wird davon abgeraten, geschweifte Klammern { } als syntaktische Platzhalter zu verwenden. Leser können Platzhalter in geschweiften Klammern mit der Notation verwechseln, die in folgenden Fällen verwendet wird:

Ersetzbarer Text
Formatzeichenfolgen
Zeichenfolgeninterpolierung
Textvorlagen
Ähnliche Programmierkonstrukte

Groß-/Kleinschreibung und Abstandszeichen: Sie können Platzhalternamen durch Bindestriche („Kebabschreibweise“) oder Unterstriche trennen, oder Sie verwenden die Pascal-Schreibweise. Bei der Kebabschreibweise treten möglicherweise Syntaxfehler auf, und sie kann zu Konflikten mit Unterstreichungen führen. Die Verwendung aller Großbuchstaben kann mit benannten Konstanten in vielen Sprachen in Konflikt stehen, kann jedoch auch auf den Platzhalternamen aufmerksam machen.

<Resource-Group-Name> oder <ResourceGroupName>

Überschriften

Wenden Sie keine Inlineformatvorlage wie Kursiv, Fett oder Inlinecode auf Überschriften an.

Warum? Überschriften haben eigene Formatvorlagen, und das Mischen anderer Formatvorlagen erstellt Inkonsistenzen.

Dies: Importieren des Microsoft.NET.Sdk.Functions-Pakets
Nicht dies: Importieren des Microsoft.NET.Sdk.Functions-Pakets

Linktext

Wenden Sie keine Inline-Formatierungen wie kursiv oder fett auf Linktext an.

Warum? Benutzer verlassen sich auf das Standardformat für Linktext, um Textelemente als klickbare Links zu identifizieren. Das Formatieren eines Links als kursiv kann z. B. die Tatsache verdecken, dass der Text ein Link ist.

Dies: Das NuGet-Paket "Microsoft.NET.Sdk.Functions" generiert die function.json Datei.

Nicht dies: Das NuGet-Paket "Microsoft.NET.Sdk.Functions" generiert die function.json Datei.

Tasten und Tastenkombinationen

Beachten Sie die folgenden Konventionen, wenn Sie auf Tasten oder Tastenkombinationen verweisen:

Schreiben Sie Tastennamen groß.
Schließen Sie Tastennamen in die HTML-Tags <kbd> und </kbd> ein.
Verwenden Sie das Pluszeichen (+), um Tasten zu kombinieren, die gleichzeitig gedrückt werden müssen.

Beispiele für Tasten und Tastenkombinationen

Richtig: Drücken Sie ALT+STRG+S.
Falsch: Drücken Sie ALT+STRG+S.
Falsch: Drücken Sie ALT+CTRL+S.

Ausnahmen

Einheitliche Stilrichtlinien schaffen eine zuverlässige Benutzererfahrung und vereinfachen den Erstellungsprozess. Ausnahmen von diesen Richtlinien müssen sorgfältig geprüft werden.

Wenn bei der Ausnahme eine alternative Textformatvorlage verwendet wird, die normalerweise Code aufruft, stellen Sie sicher, dass der Text in lokalisierten Versionen des Artikels übersetzt werden kann. Bei Szenarien, in denen Sie die Lokalisierung ohne Codeformat verhindern möchten, finden Sie entsprechende Informationen unter Nicht lokalisierte Zeichenfolgen.

Freigeben über