All rules
CA1720Naming Enabled by default: No

Identifiers should not contain type names

Identifiers should not contain type names

Microsoft docs

Description

Names of parameters and members are better used to communicate their meaning than to describe their type, which is expected to be provided by development tools. For names of members, if a data type name must be used, use a language-independent name instead of a language-specific one. For example, instead of the C# type name int, use the language-independent data type name, Int32.

Each discrete token in the name of the parameter or member is checked against the following language-specific data type names in a case-insensitive manner:

  • Bool
  • WChar
  • Int8
  • UInt8
  • Short
  • UShort
  • Int
  • UInt
  • Integer
  • UInteger
  • Long
  • ULong
  • Unsigned
  • Signed
  • Float
  • Float32
  • Float64

In addition, the names of a parameter are also checked against the following language-independent data type names in a case-insensitive manner:

  • Object
  • Boolean
  • Char
  • String
  • SByte
  • Byte
  • UByte
  • Int16
  • UInt16
  • Int32
  • UInt32
  • Int64
  • UInt64
  • IntPtr
  • Ptr
  • Pointer
  • UInptr
  • UPtr
  • UPointer
  • Single
  • Double
  • Decimal
  • Guid

Cause

The name of a parameter in a member contains a data type name.

-or-

The name of a member contains a language-specific data type name.

By default, this rule only looks at externally visible members, but this is configurable.

How to fix violations

If fired against a parameter:

Replace the data type identifier in the name of the parameter with either a term that better describes its meaning or a more generic term, such as 'value'.

If fired against a member:

Replace the language-specific data type identifier in the name of the member with a term that better describes its meaning, a language-independent equivalent, or a more generic term, such as 'value'.

Example

#pragma warning disable CA1720
// The code that's violating the rule is on this line.
#pragma warning restore CA1720

When to suppress

Occasional use of type-based parameter and member names might be appropriate. However, for new development, no known scenarios occur where you should suppress a warning from this rule. For libraries that have previously shipped, you might have to suppress a warning from this rule.

Group results
0 yes 0 no
ConsensusNone (disabled)
Severity preference (yes voters)
Suggestion0
Warning0
Error0