Do not initialize unnecessarily
TypeName |
DoNotInitializeUnnecessarily |
CheckId |
CA1805 |
Category |
Microsoft.Performance |
Breaking Change |
Non Breaking |
Cause
A static or instance constructor initializes a field to its default value. This rule ignores Managed C++ assemblies.
Rule Description
The common language runtime initializes all fields to their default values before running the constructor. In most cases, initializing a field to its default value in a constructor is redundant, which degrades performance and adds to maintenance costs. One case where it is not redundant occurs when the constructor calls another constructor of the same class or a base class constructor and that constructor initializes the field to a non-default value. In this case, changing the value of the field back to its default value can be appropriate.
How to Fix Violations
To fix a violation of this rule, remove the field initialization from the constructor. Note that the C# compiler that is included with .NET Framework 2.0 removes these unnecessary initializations when the optimize option is enabled.
You can also convert the field initialization to an assert as shown below:
Debug.Assert(field == 0);
This will comply with the rule while making it clear to programmers working with the code that the field is already initialized. This will present a more familiar model to programmers who are used to working in multiple languages.
When to Suppress Warnings
Suppress a warning from this rule if the constructor calls another constructor in the same or base class that initializes the field to a non-default value. It is also safe to suppress a warning from this rule, or disable the rule entirely, if performance and code maintenance are not priorities.
Example
The following example shows a type that contains multiple violations of the rule.
Imports System
Namespace PerformanceLibrary
Class InitializeUnnecessarily
Dim b1 As Boolean
Dim b2 As Boolean
Dim i As Integer
Dim d As Double
Dim s As String
Sub New()
b1 = True
' The following field assignments are violations of this rule.
b2 = False
i = 0
d = 0
s = Nothing
End Sub
Sub New(s As String)
Me.New()
' Exclude the warning for the following statement.
b1 = False
Me.s = s
End Sub
End Class
End Namespace
using System;
namespace PerformanceLibrary
{
class InitializeUnnecessarily
{
bool b1;
bool b2;
int i;
double d;
string s;
InitializeUnnecessarily()
{
b1 = true;
// The following field assignments are violations of this rule.
b2 = false;
i = 0;
d = 0;
s = null;
}
InitializeUnnecessarily(string s) : this()
{
// Exclude the warning for the following statement.
b1 = false;
this.s = s;
}
}
}