CA1725: Os nomes dos parâmetros devem corresponder à declaração base
| Propriedade | valor |
|---|---|
| ID da regra | CA1725 |
| Cargo | Os nomes dos parâmetros devem corresponder à declaração base |
| Categoria | Atribuição de nomes |
| A correção está quebrando ou não quebrando | Quebrando |
| Habilitado por padrão no .NET 8 | Não |
Causa
O nome de um parâmetro em uma substituição de método não corresponde ao nome do parâmetro na declaração base do método ou ao nome do parâmetro na declaração de interface do método.
Por padrão, essa regra examina apenas métodos visíveis externamente, mas isso é configurável.
Descrição da regra
A nomenclatura consistente de parâmetros em uma hierarquia de substituição aumenta a usabilidade das substituições de método. Um nome de parâmetro em um método derivado que difere do nome na declaração base pode causar confusão sobre se o método é uma substituição do método base ou uma nova sobrecarga do método.
Como corrigir violações
Para corrigir uma violação dessa regra, renomeie o parâmetro para corresponder à declaração base. A correção é uma alteração de quebra para métodos visíveis COM.
Quando suprimir avisos
Não suprima um aviso desta regra, exceto para métodos visíveis COM em bibliotecas que foram enviadas anteriormente.
Suprimir um aviso
Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar a regra.
#pragma warning disable CA1725
// The code that's violating the rule is on this line.
#pragma warning restore CA1725
Para desabilitar a regra de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.CA1725.severity = none
Para obter mais informações, consulte Como suprimir avisos de análise de código.
Configurar código para análise
Use a opção a seguir para configurar em quais partes da sua base de código executar essa regra.
Você pode configurar essa opção apenas para esta regra, para todas as regras às quais ela se aplica ou para todas as regras nesta categoria (Nomenclatura) às quais ela se aplica. Para obter mais informações, consulte Opções de configuração da regra de qualidade de código.
Incluir superfícies de API específicas
Você pode configurar em quais partes da sua base de código executar essa regra, com base em sua acessibilidade. Por exemplo, para especificar que a regra deve ser executada somente na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig em seu projeto:
dotnet_code_quality.CAXXXX.api_surface = private, internal
