CA2225: Las sobrecargas del operador tienen alternativas con nombre

  • Artículo
Propiedad Value
Identificador de la regla CA2225
Título Las sobrecargas del operador tienen alternativas con nombre
Categoría Uso
La corrección es problemática o no problemática Poco problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

Se detectó una sobrecarga del operador y no se encontró el método alternativo con el nombre esperado.

De forma predeterminada, esta regla solo examina los tipos visibles externamente, pero es configurable.

Descripción de la regla

La sobrecarga de operadores permite el uso de símbolos para representar los cálculos para un tipo. Por ejemplo, un tipo que sobrecarga el símbolo más + para la adición tendrá normalmente un miembro alternativo denominado Add. El miembro alternativo denominado proporciona acceso a la misma funcionalidad que el operador. Se proporciona para los desarrolladores que programan en lenguajes que no admiten operadores sobrecargados.

Esta regla examina:

  • Operadores de conversión implícitos y explícitos en un tipo mediante la comprobación de métodos denominados To<typename> y From<typename>.

  • Los operadores que se muestran en la tabla siguiente:

C# Visual Basic C++ Nombre del método alternativo
+ (binario) + + (binario) Sumar
+= += += Sumar
& Y & BitwiseAnd
&= And= &= BitwiseAnd
| Or | BitwiseOr
|= Or= |= BitwiseOr
-- N/D -- Decremento
/ / / Dividir
/= /= /= Dividir
== = == Equals
^ Xor ^ Xor
^= Xor= ^= Xor
> > > CompareTo o Compare
>= >= >= CompareTo o Compare
++ N/D ++ Incremento
!= <> != Equals
<< << << LeftShift
<<= <<= <<= LeftShift
< < < CompareTo o Compare
<= <= <= CompareTo o Compare
&& N/D && AND lógico
|| N/D || LogicalOr
! N/D ! LogicalNot
% Mod % Mod o Remainder
%= N/D %= Mod
* (binario) * * Multiplicar
*= N/D *= Multiplicar
~ Not ~ OnesComplement
>> >> >> RightShift
>>= N/D >>= RightShift
- (binario) - (binario) - (binario) Restar
-= N/D -= Restar
true IsTrue N/D IsTrue (propiedad)
- (unario) N/D - Negate
+ (unario) N/D + Plus
false IsFalse False IsTrue (propiedad)

*N/A significa que el operador no se puede sobrecargar en el lenguaje seleccionado.

Nota

En C#, cuando se sobrecarga un operador binario, el operador de asignación correspondiente, si lo hay, también se sobrecarga de modo implícito.

Cómo corregir infracciones

Para corregir una infracción de esta regla, implemente el método alternativo para el operador. Asígnele el nombre alternativo recomendado.

Cuándo suprimir las advertencias

No suprima una advertencia de esta regla si está implementando una biblioteca compartida. Las aplicaciones pueden omitir una advertencia de esta regla.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Configuración del código para analizar

Use la opción siguiente para configurar en qué partes del código base ejecutar esta regla.

Puede configurar esta opción solo para esta regla, para todas las reglas a las que se aplica o para todas las reglas de esta categoría (Uso) a las que se aplica. Para más información, vea Opciones de configuración de reglas de calidad de código.

Incluir superficies de API específicas

Puede configurar en qué partes del código base ejecutar esta regla, en función de su accesibilidad. Por ejemplo, para especificar que la regla solo se debe ejecutar en la superficie de API no públicas, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Ejemplo

En el ejemplo siguiente se define una estructura que infringe esta regla. Para corregir el ejemplo, agregue un método público Add(int x, int y) a la estructura.

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; } }
}