CA2225: Gli overload degli operatori hanno alternative con nome

  • Articolo
Proprietà valore
ID regola CA2225
Title Gli overload degli operatori hanno alternative con nome
Categoria Utilizzo
Correzione che causa un'interruzione o un'interruzione Nessuna interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

È stato rilevato un overload dell'operatore e il metodo alternativo denominato previsto non è stato trovato.

Per impostazione predefinita, questa regola esamina solo i tipi visibili esternamente, ma è configurabile.

Descrizione regola

L'overload degli operatori consente l'uso di simboli per rappresentare i calcoli per un tipo. Ad esempio, un tipo che esegue l'overload del simbolo + più per l'aggiunta in genere avrà un membro alternativo denominato Add. Il membro alternativo denominato consente di accedere alla stessa funzionalità dell'operatore. Viene fornita agli sviluppatori che programmano in linguaggi che non supportano operatori di overload.

Questa regola esamina:

  • Operatori cast impliciti ed espliciti in un tipo controllando i metodi denominati To<typename> e From<typename>.

  • Gli operatori elencati nella tabella seguente:

C# Visual Basic C++ Nome del metodo alternativo
+ (binario) + + (binario) Aggiungere
+= += += Aggiungere
& And & BitwiseAnd
&= And= &= BitwiseAnd
| O | BitwiseOr
|= Or= |= BitwiseOr
-- N/D -- Operatore di conversione
/ / / Divisione
/= /= /= Divisione
== = == Uguale a
^ Xor ^ Xor
^= Xor= ^= Xor
> > > CompareTo o Compare
>= >= >= CompareTo o Compare
++ N/D ++ Incremento
!= <> != Uguale a
<< << << LeftShift
<<= <<= <<= LeftShift
< < < CompareTo o Compare
<= <= <= CompareTo o Compare
&& N/D && LogicalAnd
|| N/D || LogicalOr
! N/D ! LogicalNot
% Mod % Mod o Resto
%= N/D %= Mod
* (binario) * * Moltiplicazione
*= N/D *= Moltiplicazione
~ Not ~ OnesComplement
>> >> >> RightShift
>>= N/D >>= RightShift
- (binario) - (binario) - (binario) Subtract
-= N/D -= Subtract
vero IsTrue N/D IsTrue (Property)
- (unario) N/D - Negate
+ (unario) N/D + Più
false IsFalse Falso IsTrue (Property)

*N/D indica che l'operatore non può essere sottoposto a overload nella lingua selezionata.

Nota

In C#, quando viene eseguito l'overload di un operatore binario, l'operatore di assegnazione corrispondente, se presente, viene anche sottoposto a overload implicito.

Come correggere le violazioni

Per correggere una violazione di questa regola, implementare il metodo alternativo per l'operatore . Denominarlo usando il nome alternativo consigliato.

Quando eliminare gli avvisi

Non eliminare un avviso da questa regola se si implementa una libreria condivisa. Le applicazioni possono ignorare un avviso da questa regola.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

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

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

È possibile configurare questa opzione solo per questa regola, per tutte le regole a cui si applica o per tutte le regole in questa categoria (utilizzo) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Includere superfici API specifiche

È possibile configurare le parti della codebase in modo da eseguire questa regola in base all'accessibilità. Ad esempio, per specificare che la regola deve essere eseguita solo sulla superficie dell'API non pubblica, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Esempio

Nell'esempio seguente viene definita una struttura che viola questa regola. Per correggere l'esempio, aggiungere un metodo pubblico Add(int x, int y) alla struttura .

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