org.sonar.plugins.csharp.S2178.html Maven / Gradle / Ivy
Why is this an issue?
Short-circuit evaluation is an evaluation strategy for Boolean operators, that doesn’t evaluates the second argument of the operator if it is not
needed to determine the result of the operation.
C# provides logical operators that implement short-circuit evaluation: && and ||, as well as non-short-circuit
versions: & and |. Unlike short-circuit operators, non-short-circuit ones evaluate both operands and afterwards perform
the logical operation.
For example false && FunctionCall() always results in false, even when FunctionCall invocation would
raise an exception. Instead, false & FunctionCall() also evaluates FunctionCall(), and results in an exception if
FunctionCall() invocation raises an exception.
Similarly, true || FunctionCall() always results in true, no matter what the return value of FunctionCall()
would be.
The use of non-short-circuit logic in a boolean context is likely a mistake - one that could cause serious program errors as conditions are
evaluated under the wrong circumstances.
How to fix it
Code examples
Noncompliant code example
if (GetTrue() | GetFalse()) // Noncompliant: both sides evaluated
{
}
Compliant solution
if (GetTrue() || GetFalse()) // Compliant: short-circuit logic used
{
}
Resources
Documentation
Articles & blog posts