Freigeben über

CA1707: Bezeichner sollten keine Unterstriche enthalten.

Eigenschaft Wert
Regel-ID CA1707
Titel Bezeichner sollten keine Unterstriche enthalten.
Kategorie Benennung
Fix führt oder führt nicht zur Unterbrechung Unterbrechen: Wenn für Assemblys ausgelöst

Nicht unterbrechen: Wenn für Typparameter ausgelöst
Standardmäßig in .NET 9 aktiviert No

Ursache

Der Name eines Bezeichners enthält den Unterstrich (_).

Regelbeschreibung

Bezeichnernamen dürfen keinen Unterstrich (_) enthalten. Namespaces, Typen, Member und Parameter werden von dieser Regel überprüft.

Durch Benennungskonventionen erhalten Bibliotheken, die auf die Common Language Runtime abzielen, ein einheitliches Erscheinungsbild. Dadurch wird der Lernaufwand für neue Softwarebibliotheken verringert. Zudem wird das Kundenvertrauen dahingehend gestärkt, dass die Bibliothek von einem erfahrenen Entwickler für verwalteten Code erstellt wurde.

Behandeln von Verstößen

Entfernen Sie alle Unterstriche aus dem Namen.

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie keine Warnungen für Produktionscode. Sie können diese Warnung jedoch für Testcode unterdrücken.

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 CA1707
// The code that's violating the rule is on this line.
#pragma warning restore CA1707

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der none auf fest.

[*.{cs,vb}]
dotnet_diagnostic.CA1707.severity = none

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Für bekannte Methoden in Microsoft-Code, die derzeit einen Unterstrich verwenden und nicht geändert werden können, sollte die Regel unterdrückt werden.

Konfigurieren des zu analysierenden Codes

Mithilfe der folgenden Option können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.

Sie können diese Option nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Benennung) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.

Einschließen bestimmter API-Oberflächen

Mit der Option api_surface können Sie festlegen, für welche Elemente Ihrer Codebasis diese Regel ausgeführt werden soll, und zwar auf der Grundlage ihrer Zugreifbarkeit. Sie können beispielsweise festlegen, dass die Regel nur für die nicht öffentliche API-Oberfläche ausgeführt werden soll, indem Sie einer EDITORCONFIG-Datei in Ihrem Projekt das folgende Schlüssel-Wert-Paar hinzufügen:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Hinweis

Ersetzen Sie das XXXX-Element von CAXXXX durch die ID der entsprechenden Regel.