Udostępnij za pośrednictwem

CA1720: Identyfikatory nie powinny zawierać nazw typów

  • Artykuł

TypeName

IdentifiersShouldNotContainTypeNames

CheckId

CA1720

Kategoria

Microsoft.Naming

Zmiana kluczowa

Kluczowa

Przyczyna

Nazwa parametru widoczna na zewnątrz elementu członkowskiego zawiera nazwę typu danych.

-lub-

Nazwa elementu członkowskiego widocznego na zewnątrz zawiera nazwę typu danych języka.

Opis reguły

Nazwy parametrów i elementów członkowskich powinny być używane do komunikowania się ich znaczeniem, zamiast ich typem, którego dostarczenie jest oczekiwane przez narzędzia programistyczne.Dla nazwy elementów członkowskich, jeśli musi zostać użyta nazwa typu danych, należy użyć nazwy niezależnej od wielu języków, zamiast jednego.Na przykład zamiast nazwy typu C# "int", należy użyć nazwy typu danych niezależnego od języka, Int32.

Każdy dyskretny token w nazwie parametru lub elementu członkowskiego jest sprawdzany pod kątem następujących, charakterystycznych dla języka nazw typów danych, nie uwzględniając wielkości liter:

  • Bool

  • WChar

  • Int8

  • UInt8

  • Liczba krótka

  • UShort

  • Int

  • UInt

  • Liczba całkowita

  • UInteger

  • Liczba długa

  • ULong

  • Unsigned

  • Signed

  • Float

  • Float32

  • Float64

Ponadto nazwy parametrów również są sprawdzane pod kątem następujących, charakterystycznych dla języka nazwy typów danych niezależnych od języka, nie uwzględniając wielkości liter:

  • Obiekt

  • Obj

  • Wartość logiczna

  • Char

  • Ciąg

  • SByte

  • Bajt

  • UByte

  • Int16

  • UInt16

  • Int32

  • UInt32

  • Int64

  • UInt64

  • IntPtr

  • Ptr

  • Pointer

  • UInptr

  • UPtr

  • UPointer

  • Pojedyncze

  • Wartość dwubajtowa

  • Wartość dziesiętna

  • Guid

Jak naprawić naruszenia

Jeśli nastąpiło naruszenie parametru:

Zastąp identyfikator typu danych w nazwie parametru terminem, który lepiej opisuje znaczenie, lub bardziej ogólnym terminem, na przykład "wartość".

Jeśli nastąpiło naruszenie elementu członkowskiego:

Zastąp charakterystyczny dla języka identyfikator typu danych w nazwie elementu członkowskiego terminem, który lepiej opisuje znaczenie, równoważnym niezależnym od języka, lub bardziej ogólnym terminem, na przykład "wartość".

Kiedy pominąć ostrzeżenia

Okazjonalne użycie nazw typów w nazwach parametru i elementu członkowskiego może być właściwe.Jednakże dla nowego oprogramowania, nie występują znane scenariusze, gdzie należy pomijać ostrzeżenia od tej reguły.Dla bibliotek, które zostały wydane wcześniej można pomijać ostrzeżenia od tej reguły.

Powiązane reguły

CA1709: Identyfikatory powinny być zapisywane z uwzględnieniem wielkości liter

CA1708: Identyfikatory powinny różnić się czymś więcej niż wielkością liter

CA1707: Identyfikatory nie powinny zawierać podkreśleń

CA1719: Nazwy parametrów nie powinny odpowiadać nazwom elementów członkowskich