C#


ROSLYN.DESIGN.CA1067 : Override Object.Equals(object) when implementing IEquatable<T> (C#)

See Roslyn-Detected C# Warning Classes for more information.

Summary

When a type T implements the interface IEquatable, it suggests to a user who sees a call to the Equals method in source code that an instance of the type can be equated with an instance of any other type. The user might be confused if their attempt to equate the type with an instance of another type fails to compile. This violates the "principle of least surprise".

This check corresponds to Roslyn rule CA1067. For full rule details, see the Microsoft website: CA1067.

Properties

Class Name Override Object.Equals(object) when implementing IEquatable<T> (C#)
Significance reliability
Mnemonic ROSLYN.DESIGN.CA1067
Categories None
Availability Available for C# only.
Enabling Checks for this warning class are enabled by default. To disable them, add the following WARNING_FILTER rule to the project configuration file.
WARNING_FILTER += discard class="Override Object.Equals(object) when implementing IEquatable<T> (C#)"

Relevant Configuration File Parameters

The following configuration file parameters affect checks for this warning class.