CA1720: Identifikátory by neměly obsahovat názvy typů
Název_typu |
IdentifiersShouldNotContainTypeNames |
CheckId |
CA1720 |
Kategorie |
Microsoft.Naming |
Změnit rozdělení |
Rozdělení |
Příčina
Název parametru externě viditelné člena obsahuje název datového typu.
-nebo-
Název externě viditelné člen obsahuje název jazyka datového typu.
Popis pravidla
Názvy parametrů a členové slouží lépe komunikovat význam než se popisují jejich typ, který se očekává, že poskytuje nástroje pro vývoj.Pro názvy členů je-li název datového typu, musí být použita, použijte název jazykově nezávislý namísto jednoho jazyka.Například místo C# typu název 'int', použijte název typu dat nezávislý na jazyce Int32.
Každý token diskrétní jménem parametr nebo člen se bude kontrolovat vůči následující názvy typů dat jazyka způsobem, velká a malá písmena:
Bool
WChar
Int8
UInt8
Short
UShort
Int
UInt
Integer
UInteger
Dlouhá
ULong
Bez znaménka
Podepsaný
Plovák
Float32
Float64
Kromě toho jména parametr také kontrolován následující názvy typu dat nezávislý na jazyce způsobem, velká a malá písmena:
Objekt
Obj
Logická
Char
Řetězec
SByte
Byte
UByte
Int16
UInt16
Int32
UInt32
Int64
UInt64
IntPtr
PTR
Ukazatel
UInptr
UPtr
UPointer
Jednoduché
Double
Desetinné číslo
Guid
Jak opravit porušení
Pokud je aktivována před parametr:
Identifikátor typu dat jménem parametr nahraďte termín, který lépe popisuje její význam nebo více obecný pojem, například "hodnota".
Pokud je aktivována před člen:
Identifikátor typu dat jazyka jménem člena nahraďte termín, který lépe popisuje její význam, nezávislý na jazyce rovnocenné nebo více obecný pojem, například "hodnota".
Při potlačení upozornění
Příležitostné použití názvů založené na typu parametru a člen může být vhodná.Pro nový vývoj žádné známé však nastat scénáře, kde by měl potlačit varování od tohoto pravidla.Pro knihovny, které mají předchozí dodáno pravděpodobně potlačí upozornění od tohoto pravidla.
Souvisejících pravidel
CA1709: Malá a velká písmena identifikátorů by měla být použita správně
CA1708: Identifikátory by se měly lišit více než použitím malých a velkých písmen