CA2231 : Surchargez l'opérateur égal (equals) en remplaçant ValueType.EqualsCA2231: Overload operator equals on overriding ValueType.Equals

TypeNameTypeName OverloadOperatorEqualsOnOverridingValueTypeEqualsOverloadOperatorEqualsOnOverridingValueTypeEquals
CheckIdCheckId CA2231CA2231
CategoryCategory Microsoft.UsageMicrosoft.Usage
Modification avec ruptureBreaking Change Sans ruptureNon Breaking

CauseCause

Un type valeur se substitue System.Object.Equals mais n’implémente ne pas l’opérateur d’égalité.A value type overrides System.Object.Equals but does not implement the equality operator.

Description de la règleRule Description

Dans la plupart des langages de programmation il n’existe aucune implémentation par défaut de l’opérateur d’égalité (==) pour les types valeur.In most programming languages there is no default implementation of the equality operator (==) for value types. Si votre langage de programmation prend en charge les surcharges d’opérateur, vous devez envisager d’implémenter l’opérateur d’égalité.If your programming language supports operator overloads, you should consider implementing the equality operator. Son comportement doit être identique à celui de Equals.Its behavior should be identical to that of Equals.

Vous ne pouvez pas utiliser l’opérateur d’égalité par défaut dans une implémentation surchargée de l’opérateur d’égalité.You cannot use the default equality operator in an overloaded implementation of the equality operator. Cela provoque un dépassement de capacité de pile.Doing so will cause a stack overflow. Pour implémenter l’opérateur d’égalité, utilisez la méthode Object.Equals dans votre implémentation.To implement the equality operator, use the Object.Equals method in your implementation. Par exemple :For example:

If (Object.ReferenceEquals(left, Nothing)) Then
    Return Object.ReferenceEquals(right, Nothing)
Else
    Return left.Equals(right)
End If
if (Object.ReferenceEquals(left, null))
    return Object.ReferenceEquals(right, null);
return left.Equals(right);

Comment corriger les violationsHow to Fix Violations

Pour corriger une violation de cette règle, implémentez l’opérateur d’égalité.To fix a violation of this rule, implement the equality operator.

Quand supprimer les avertissementsWhen to Suppress Warnings

Il est possible de supprimer un avertissement de cette règle ; Toutefois, nous vous recommandons de fournir l’opérateur d’égalité si possible.It is safe to suppress a warning from this rule; however, we recommend that you provide the equality operator if possible.

ExempleExample

L’exemple suivant définit un type qui viole cette règle.The following example defines a type that violates this rule.

using System;

namespace UsageLibrary
{
    public struct PointWithoutHash
    {
        private int x,y;
        
        public PointWithoutHash(int x, int y)
        {
            this.x = x;
            this.y = y;
        }
        
        public override string ToString()
        {
            return String.Format("({0},{1})",x,y);
        }
        
        public int X {get {return x;}}
        
        public int Y {get {return x;}}
        
        // Violates rule: OverrideGetHashCodeOnOverridingEquals.
        // Violates rule: OverrideOperatorEqualsOnOverridingValueTypeEquals.
        public override bool Equals (object obj)
        {
            if (obj.GetType() != typeof(PointWithoutHash))
                return false;
                
            PointWithoutHash p = (PointWithoutHash)obj;   
            return ((this.x == p.x) && (this.y == p.y));
        }
        
    }

}

CA1046 : Ne pas surcharger l’opérateur égal sur les types de référenceCA1046: Do not overload operator equals on reference types

CA2225 : Les surcharges d’opérateur ont d’autres méthodes nomméesCA2225: Operator overloads have named alternates

CA2226 : Les opérateurs doivent avoir des surcharges symétriquesCA2226: Operators should have symmetrical overloads

CA2224 : Remplacez Equals lors de la surcharge de l’opérateur égalCA2224: Override equals on overloading operator equals

CA2218 : Remplacez GetHashCode lors du remplacement de EqualsCA2218: Override GetHashCode on overriding Equals

Voir aussiSee Also

System.Object.Equals