CA1500: Variable names should not match field names
For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.
|Breaking Change||When fired on a parameter that has the same name as a field:|
- Non-breaking - If both the field and method that declares the parameter cannot be seen outside the assembly, regardless of the change you make.
- Breaking - If you change the name of the field and can be seen outside the assembly.
- Breaking - If you change the name of the parameter and the method that declares it can be seen outside the assembly.
When fired on a local variable that has the same name as a field:
- Non-breaking - If the field cannot be seen outside the assembly, regardless of the change you make.
- Non-breaking - If you change the name of the local variable and do not change the name of the field.
- Breaking - If you change the name of the field and it can be seen outside the assembly.
An instance method declares a parameter or a local variable whose name matches an instance field of the declaring type. To catch local variables that violate the rule, the tested assembly must be built by using debugging information and the associated program database (.pdb) file must be available.
When the name of an instance field matches a parameter or a local variable name, the instance field is accessed by using the
Me in Visual Basic) keyword when inside the method body. When maintaining code, it is easy to forget this difference and assume that the parameter/local variable refers to the instance field, which leads to errors. This is true especially for lengthy method bodies.
To fix a violation of this rule, rename either the parameter/variable or the field.
Do not suppress a warning from this rule.
The following example shows two violations of the rule.