CA1720: Identificadores não devem conter nomes de tipos

  • Artigo
Property Valor
ID da regra CA1720
Título Identificadores não devem conter nomes de tipos
Categoria Nomenclatura
Correção interruptiva ou sem interrupção Quebra
Habilitado por padrão no .NET 8 Não

Causa

O nome de um parâmetro em um membro contém um nome de tipo de dados.

-ou-

O nome de um membro contém um nome de tipo de dados específico da linguagem.

Por padrão, essa regra analisa apenas os membros externamente visíveis, mas isso é configurável.

Descrição da regra

Nomes de parâmetros e membros são melhor usados para comunicar seu significado do que para descrever seu tipo, o que é esperado que seja fornecido pelas ferramentas de desenvolvimento. Para nomes de membros, se um nome de tipo de dados precisar ser usado, use um nome independente de linguagem em vez de um específico de linguagem. Por exemplo, em vez do nome int do tipo C#, use o nome do tipo de dados independente de linguagem, Int32.

Cada token discreto no nome do parâmetro ou membro é verificado em relação aos seguintes nomes de tipo de dados específicos da linguagem de uma maneira que não diferencia maiúsculas de minúsculas:

  • Bool
  • WChar
  • Int8
  • UInt8
  • Short
  • UShort
  • int
  • UInt
  • Inteiro
  • UInteger
  • long
  • ULong
  • Não assinado
  • Com sinal
  • Float
  • Float32
  • Float64

Além disso, os nomes de um parâmetro também são verificados em relação aos seguintes nomes de tipo de dados independentes de linguagem de uma maneira que não diferencia maiúsculas de minúsculas:

  • Objeto
  • Booliano
  • Char
  • String
  • SByte
  • Byte
  • UByte
  • Int16
  • UInt16
  • Int32
  • UInt32
  • Int64
  • UInt64
  • IntPtr
  • Ptr
  • Ponteiro
  • UInptr
  • UPtr
  • UPointer
  • Single
  • Double
  • Decimal
  • Guid

Como corrigir violações

Se disparada contra um parâmetro:

Substitua o identificador de tipo de dados no nome do parâmetro por um termo que descreva melhor seu significado ou um termo mais genérico, como 'value'.

Se disparada contra um membro:

Substitua o identificador de tipo de dados específico de linguagem no nome do membro por um termo que descreva melhor seu significado, um equivalente independente de linguagem ou um termo mais genérico, como 'value'.

Quando suprimir avisos

O uso ocasional de parâmetros baseados nomes de tipos e de membros pode ser apropriado. No entanto, para um novo desenvolvimento, não ocorrem cenários conhecidos em que seja necessário suprimir um aviso dessa regra. Para bibliotecas que já foram enviadas anteriormente, talvez seja necessário suprimir um aviso dessa regra.

Suprimir um aviso

Para suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem a fim de desabilitar e, em seguida, reabilitar a regra.

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

Para desabilitar a regra em um arquivo, uma pasta ou um projeto, defina a severidade como none no arquivo de configuração.

[*.{cs,vb}]
dotnet_diagnostic.CA1720.severity = none

Para obter mais informações, confira Como suprimir avisos de análise de código.

Configurar código para analisar

Use a opção a seguir para configurar em quais partes da base de código essa regra deve ser executada.

Você pode configurar essa opção apenas para essa regra, para todas as regras às quais ela se aplica ou para todas as regras nessa categoria (Nomenclatura) às quais ela se aplica. Para saber mais, confira Opções de configuração de regra de qualidade de código.

Incluir superfícies de API específicas

É possível configurar em quais partes da base de código essa regra deverá ser executada, com base na acessibilidade. Por exemplo, para especificar que a regra deverá ser executada apenas na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig no projeto:

dotnet_code_quality.CAXXXX.api_surface = private, internal