CA1711: Bezeichner sollten kein falsches Suffix aufweisen

TypeName	IdentifiersShouldNotHaveIncorrectSuffix
CheckId	CA1711
Kategorie	Microsoft.Naming
Unterbrechende Änderung	Breaking

Ursache

Ein Bezeichner weist ein falsches Suffix auf.

Regelbeschreibung

Nur die Namen von Typen, die bestimmte Basistypen erweitern oder bestimmte Schnittstellen bzw. Typen implementieren, die von diesen Typen abgeleitet werden, sollten stets mit bestimmten reservierten Suffixen enden. Für andere Typnamen sollten diese reservierten Suffixe nicht verwendet werden.

In der folgenden Tabelle werden die reservierten Suffixe sowie die Basistypen und die Schnittstellen aufgeführt, denen die Suffixe zugeordnet sind.

Suffix	Basistyp/Schnittstelle
Attribute	System.Attribute
Collection	System.Collections.ICollection System.Collections.IEnumerable System.Collections.Queue System.Collections.Stack System.Collections.Generic.ICollection<T> System.Data.DataSet System.Data.DataTable
Dictionary	System.Collections.IDictionary System.Collections.Generic.IDictionary<TKey, TValue>
EventArgs	System.EventArgs
EventHandler	Ein Ereignishandlerdelegat.
Ausnahme	System.Exception
Berechtigung	System.Security.IPermission
Queue	System.Collections.Queue
Stack	System.Collections.Stack
Stream	System.IO.Stream

Außerdem sollten die folgenden Suffixe nicht verwendet werden:

• Delegat

• Enum

• Impl – Verwenden Sie stattdessen 'Core'.

• Ex oder ein ähnliches Suffix zur Unterscheidung von einer früheren Version desselben Typs

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 das Suffix aus dem Typnamen.

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie keine Warnung dieser Regel.

Verwandte Regeln

CA1710: Bezeichner sollten ein richtiges Suffix aufweisen

Siehe auch

Referenz

Richtlinien für die Verwendung von Attributen

Konzepte

Ereignisse und Delegaten