C#


ROSLYN.PERFORMANCE.CA1815 : Override equals and operator equals on value types (C#)

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

Summary

For value types, the inherited implementation of Equals uses the Reflection library and compares the contents of all fields. Reflection is computationally expensive, and comparing every field for equality might be unnecessary. If you expect users to compare or sort instances, or to use instances as hash table keys, your value type should implement Equals.

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

Properties

Class Name Override equals and operator equals on value types (C#)
Significance reliability
Mnemonic ROSLYN.PERFORMANCE.CA1815
Categories None
Availability Available for C# only.
Enabling Checks for this warning class are disabled by default. To enable them, add the following WARNING_FILTER rule to the project configuration file.
WARNING_FILTER += allow class="Override equals and operator equals on value types (C#)"

Relevant Configuration File Parameters

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