Sprache und unnötige Regeln

Codestil-Sprachregeln beeinflussen, wie verschiedene Konstrukte von .NET Programmiersprachen verwendet werden, z. B. Modifizierer und Klammern.

Diese Kategorie beinhaltet auch Regeln, die verschiedene Teile der Codebasis identifiziert, die unnötig sind und neu faktoriert oder entfernt werden können. Das Vorhandensein von unnötigem Code weist auf ein oder mehrere der folgenden Probleme hin:

  • Lesbarkeit: Code, der eine unnötige Verringerung der Lesbarkeit verursacht.
  • Wartbarkeit: Code, der nach dem Refactoring nicht mehr verwendet wird und unnötig verwaltet wird.
  • Leistung: unnötige Berechnung, die keine Nebenwirkungen hat und zu unnötigem Leistungsaufwand führt.
  • Funktionalität: Funktionales Problem im Code, das dazu führt, dass erforderlicher Code redundant wird. IDE0060 kennzeichnet beispielsweise nicht verwendete Parameter, bei denen die Methode versehentlich einen Eingabeparameter ignoriert.

Die Sprachregeln werden in die folgenden Kategorien eingeteilt:

  • .NET Formatvorlagenregeln: Regeln, die sowohl für C# als auch für Visual Basic gelten. Die Optionsnamen für diese Regeln beginnen mit dem Präfix dotnet_style_.
  • C#-Formatregeln: Regeln, die speziell für C#-Code gelten. Die Optionsnamen für diese Regeln beginnen mit dem Präfix csharp_style_.
  • Visual Basic Formatvorlagenregeln: Regeln, die für Visual Basic Code spezifisch sind. Die Optionsnamen für diese Regeln beginnen mit dem Präfix visual_basic_style_.

Format der Optionen

Viele der Sprachregeln verfügen über eine oder mehrere zugeordnete Optionen zum Anpassen des bevorzugten Stils. Verwenden einer einfachen "using"-Anweisung (IDE0063) verfügt beispielsweise über die zugehörige Option csharp_prefer_simple_using_statement, mit der Sie definieren können, ob Sie eine using Deklaration oder eine using Anweisung bevorzugen. Die Regel setzt die von Ihnen gewählten Optionen auf einer angegebenen Ebene durch, z. B. Warnung oder Fehler.

Optionen für Sprachregeln können in einer Konfigurationsdatei im folgenden Format angegeben werden:

option_name = value (Visual Studio 2019 und höher)

oder

option_name = value:severity

  • Wert

    Für jede Sprachregel geben Sie einen Wert an, der festlegt, ob oder wann Sie den Stil bevorzugen. Viele Regeln akzeptieren den Wert true (dieses Format bevorzugen) oder false (dieses Format nicht bevorzugen). Andere Regeln akzeptieren Werte wie when_on_single_line oder never.

  • Severity (optional in Visual Studio 2019 und höheren Versionen)

    Der zweite Teil der Regel gibt den Schweregrad für die Regel an. In .NET 9 und späteren Versionen wird der Schweregrad immer beachtet, d.h. innerhalb der Entwicklungs-IDEs und während der Befehlszeilen-Builds. In .NET 8 und früheren Versionen wird diese Schweregradeinstellung nur innerhalb von Entwicklungs-IDEs wie Visual Studio und not während des Builds berücksichtigt.

    Wenn Sie das .NET 8 SDK oder eine frühere Version verwenden und den Schweregrad zur Buildzeit beachten möchten, können Sie dies auf eine von zwei Arten tun:

    • Legen Sie die Eigenschaft <AnalysisLevel> auf <AnalysisLevelStyle> oder 9.0 oder höher fest oder auf preview.
    • Legen Sie stattdessen den Schweregrad mithilfe der regel-ID-basierten Konfigurationssyntax für Analyzer fest. Die Syntax sieht wie folgt aus: dotnet_diagnostic.<rule ID>.severity = <severity>. Beispiel: dotnet_diagnostic.IDE0040.severity = warning. Weitere Informationen finden Sie unter Schweregrad.

Tipp

Ab Visual Studio 2019 können Sie Regeln für Codeformate über das Fehlerbehebungsmenü Schnellaktionen konfigurieren, wenn ein Formatverstoß auftritt.

Regelindex

Sprach- und unnötige Coderegeln werden weiter in Unterkategorien unterteilt, z. B. Einstellungen auf Ausdrucksebene, Codeblockeinstellungen und Modifizierereinstellungen.

using Richtlinie Einstellungen

.NET Formatvorlagenregeln (C# und Visual Basic):

C#-Formatregeln:

Codeblock-Einstellungen

C#-Formatregeln:

Ausdruckskörpermember

C#-Formatregeln:

Präferenzen auf Expressionsebene

.NET Formatvorlagenregeln (C# und Visual Basic):

C#-Formatregeln:

Visual Basic Stilregeln:

Einstellungen für Felder

.NET Formatvorlagenregeln (C# und Visual Basic):

Einstellungen für Sprach- Schlüsselwort und Frameworktypen

.NET Formatvorlagenregeln (C# und Visual Basic):

Einstellungen von Modifizierern

.NET Formatvorlagenregeln (C# und Visual Basic):

C#-Formatregeln:

Einstellungen für neue Zeilen

.NET Formatvorlagenregeln (C# und Visual Basic):

C#-Formatregeln:

†These Regeln sind experimentell und unterliegen Änderungen oder Entfernungen.

Einstellungen für die NULL-Überprüfung

C#-Formatregeln:

Parameterpräferenzen

.NET Formatvorlagenregeln (C# und Visual Basic):

Einstellungen für Klammern

.NET Formatvorlagenregeln (C# und Visual Basic):

Einstellungen für den Musterabgleich

C#-Formatregeln:

Unterdrückungseinstellungen

.NET Formatvorlagenregeln (C# und Visual Basic):

C#-Formatregeln:

This. und me. Einstellungen

.NET Formatvorlagenregeln (C# und Visual Basic):

var Einstellungen

C#-Formatregeln:

Siehe auch

  • Last updated on