CA1727: Verwenden von PascalCase für benannte Platzhalter
Eigenschaft | Wert |
---|---|
Regel-ID | CA1727 |
Titel | Verwenden Sie PascalCase für benannte Platzhalter |
Kategorie | Benennung |
Fix führt oder führt nicht zur Unterbrechung | Nicht unterbrechend |
Standardmäßig in .NET 8 aktiviert | Nein |
Ursache
Ein benannter Platzhalter, der mit ILogger verwendet wird, ist nicht PascalCase.
Regelbeschreibung
Ein benannter Platzhalter, der mit ILogger verwendet wird, muss PascalCase sein, eine Namenskonvention, bei der der erste Buchstabe jedes zusammengesetzten Worts in einem Namen großgeschrieben wird. Diese Namenskonvention wird für die strukturierte Protokollierung empfohlen, bei der jeder benannte Platzhalter in den strukturierten Daten als Eigenschaftsname verwendet wird.
Behandeln von Verstößen
Verwenden Sie PascalCase für benannte Platzhalter. Sie können z. B. {firstName}
in {FirstName}
ändern.
Wann sollten Warnungen unterdrückt werden?
Eine Warnung, die auf dieser Regel basiert, kann problemlos unterdrückt werden.
Unterdrücken einer Warnung
Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.
#pragma warning disable CA1727
// The code that's violating the rule is on this line.
#pragma warning restore CA1727
Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none
fest.
[*.{cs,vb}]
dotnet_diagnostic.CA1727.severity = none
Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.