CA1724: Typennamen dürfen nicht mit Namespaces übereinstimmen

  • Artikel
Eigenschaft Wert
Regel-ID CA1724
Titel Typnamen sollten nicht mit Namespaces übereinstimmen.
Kategorie Benennung
Fix führt oder führt nicht zur Unterbrechung Breaking
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Ein Typenname stimmt mit einem Namespace-Namen überein, auf den verwiesen wird, der einen oder mehrere extern sichtbare Typen aufweist. Beim Vergleich wird die Groß- und Kleinschreibung nicht berücksichtigt.

Regelbeschreibung

Vom Benutzer erstellte Typennamen dürfen nicht mit den Namen von Namespaces, auf die verwiesen wird, mit extern sichtbaren Typen verglichen werden. Durch einen Verstoß gegen diese Regel kann die Verwendbarkeit der Bibliothek eingeschränkt werden.

Behandeln von Verstößen

Vom Benutzer erstellte Typennamen dürfen nicht mit den Namen von Namespaces, auf die verwiesen wird, mit extern sichtbaren Typen verglichen werden.

Wann sollten Warnungen unterdrückt werden?

Bei der neuen Entwicklung treten jedoch keine bekannten Szenarien auf, in denen Sie eine Warnung aus dieser Regel unterdrücken müssen. Bevor Sie die Warnung unterdrücken, sollten Sie sorgfältig überlegen, wie die Benutzer Ihrer Bibliothek durch den übereinstimmenden Namen verwechselt werden könnten. Beim Versand von Bibliotheken müssen Sie möglicherweise eine Warnung aus dieser Regel 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 CA1724
// The code that's violating the rule is on this line.
#pragma warning restore CA1724

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.CA1724.severity = none

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

Beispiel

namespace MyNamespace
{
    // This class violates the rule
    public class System
    {
    }
}