Bezeichner dürfen keine Typnamen enthalten
Aktualisiert: November 2007
TypeName |
IdentifiersShouldNotContainTypeNames |
CheckId |
CA1720 |
Kategorie |
Microsoft.Naming |
Unterbrechende Änderung |
Breaking |
Ursache
Der Name eines Parameters in einem extern sichtbaren Member enthält einen Datentypnamen.
- oder -
Der Name eines extern sichtbaren Members enthält einen sprachspezifischen Datentypnamen.
Regelbeschreibung
Parameternamen und Membernamen eignen sich besser zur Information über ihre Bedeutung als zur Beschreibung des Typs. Dieser sollte von Entwicklungstools angegeben werden. Wenn ein Datentypname verwendet werden muss, verwenden Sie für Membernamen anstelle eines sprachspezifischen Namens einen sprachunabhängigen. Verwenden Sie z. B. statt des C#-Typnamens 'int' den sprachunabhängigen Datentypnamen Int32.
Jedes diskrete Token im Parameter- oder Membernamen wird unter Ignorierung der Groß-/Kleinschreibung mit den folgenden sprachspezifischen Typnamen verglichen:
Bool
WChar
Int8
UInt8
Short
UShort
Int
UInt
Integer
UInteger
Long
ULong
Unsigned
Signed
Float
Float32
Float64
Darüber hinaus werden die Parameternamen auch unter Ignorierung der Groß-/Kleinschreibung mit den folgenden sprachunabhängigen Datentypnamen verglichen:
Object
Obj
Boolean
Char
String
Sbyte
Byte
UByte
Int16
UInt16
Int32
UInt32
Int64
UInt64
IntPtr
Ptr
Pointer
UInptr
UPtr
UPointer
Single
Double
Decimal
Guid
Behandlung von Verstößen
Bei Auslösung gegen einen Parameter:
Ersetzen Sie den Datentypbezeichner im Parameternamen mit einem Begriff, der seine Bedeutung besser beschreibt, oder einem allgemeineren Begriff, z. B. 'value'.
Bei Auslösung gegen einen Member:
Ersetzen Sie den sprachspezifischen Datentypbezeichner im Membernamen mit einem Begriff, der seine Bedeutung besser beschreibt, einer sprachunabhängigen Entsprechung oder einem allgemeineren Begriff, z. B. 'value'.
Wann sollten Warnungen unterdrückt werden?
Gelegentlich können auch typbasierte Parameter- und Membernamen verwendet werden. In Zusammenhang mit Neuentwicklungen ist jedoch kein Szenario bekannt, bei dem es notwendig ist, eine Warnung dieser Regel zu unterdrücken. Bei Bibliotheken, die zuvor versandt wurden, müssen Sie u. U. eine Warnung dieser Regel unterdrücken.
Verwandte Regeln
Bei Bezeichnern sollte die Groß-/Kleinschreibung beachtet werden
Bezeichner sollten sich nicht nur durch die Groß-/Kleinschreibung unterscheiden