CA2225: Sobrecargas de operador têm alternativas nomeadas
| Property | Valor |
|---|---|
| ID da regra | CA2225 |
| Título | Sobrecargas de operador têm alternativas nomeadas |
| Categoria | Usage |
| Correção interruptiva ou sem interrupção | Sem interrupção |
| Habilitado por padrão no .NET 9 | Não |
Causa
Uma sobrecarga de operador foi detectada e o método alternativo nomeado esperado não foi encontrado.
Por padrão, essa regra apenas analisa os tipos visíveis externamente, mas isso é configurável.
Descrição da regra
A sobrecarga de operador permite o uso de símbolos para representar cálculos para um tipo. Por exemplo, um tipo que sobrecarrega o símbolo de adição + normalmente teria um membro alternativo chamado Add. O membro alternativo nomeado fornece acesso à mesma funcionalidade do operador. Ele é fornecido para desenvolvedores que programam em linguagens que não possuem suporte a operadores de sobrecarga.
Esta regra examina:
Operadores de conversão implícita e explícita em um tipo verificando métodos chamados
To<typename>eFrom<typename>.Os operadores listados na seguinte tabela:
| C# | Visual Basic | C++ | Nome do método alternativo |
|---|---|---|---|
| + (binário) | + | + (binário) | Adicionar |
| += | += | += | Adicionar |
| & | And | & | BitwiseAnd |
| &= | And= | &= | BitwiseAnd |
| | | Ou | | | BitwiseOr |
| |= | Or= | |= | BitwiseOr |
| -- | N/D | -- | Decremento |
| / | / | / | Dividir |
| /= | /= | /= | Dividir |
| == | = | == | É igual a |
| ^ | Xor | ^ | Xor |
| ^= | Xor= | ^= | Xor |
| > | > | > | CompareTo ou Compare |
| >= | >= | >= | CompareTo ou Compare |
| ++ | N/D | ++ | Incremento |
| != | <> | != | É igual a |
| << | << | << | LeftShift |
| <<= | <<= | <<= | LeftShift |
| < | < | < | CompareTo ou Compare |
| <= | <= | <= | CompareTo ou Compare |
| && | N/D | && | LogicalAnd |
| || | N/D | || | LogicalOr |
| ! | N/D | ! | LogicalNot |
| % | Mod | % | Mod or Remainder |
| %= | N/D | %= | Mod |
| * (binário) | * | * | Multiplicar |
| *= | N/D | *= | Multiplicar |
| ~ | Not | ~ | OnesComplement |
| >> | >> | >> | RightShift |
| >>= | N/D | >>= | RightShift |
| - (binário) | - (binário) | - (binário) | Subtrair |
| -= | N/D | -= | Subtrair |
| true | IsTrue | N/D | IsTrue (Propriedade) |
| – (unário) | N/D | - | Negar |
| + (unário) | N/D | + | Plus |
| false | IsFalse | Falso | IsTrue (Propriedade) |
*N/A significa que o operador não pode ser sobrecarregado no idioma selecionado.
Observação
Em C#, quando um operador binário está sobrecarregado, o operador de atribuição correspondente, se houver, também estará implicitamente sobrecarregado.
Como corrigir violações
Para corrigir uma violação dessa regra, implemente o método alternativo para o operador. Nomeie-o usando o nome alternativo recomendado.
Quando suprimir avisos
Não suprima um aviso dessa regra se você estiver implementando uma biblioteca compartilhada. Os aplicativos podem ignorar 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 CA2225
// The code that's violating the rule is on this line.
#pragma warning restore CA2225
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.CA2225.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 (Uso) à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
Exemplo
O exemplo a seguir define uma estrutura que viola essa regra. Para corrigir o exemplo, adicione um método Add(int x, int y) público à estrutura.
public struct Point
{
private int x, y;
public Point(int x, int y)
{
this.x = x;
this.y = y;
}
public override string ToString()
{
return String.Format("({0},{1})", x, y);
}
// Violates rule: OperatorOverloadsHaveNamedAlternates.
public static Point operator +(Point a, Point b)
{
return new Point(a.x + b.x, a.y + b.y);
}
public int X { get { return x; } }
public int Y { get { return x; } }
}
