rspec/rules/S2201/csharp/rule.adoc

47 lines
1.4 KiB
Plaintext
Raw Normal View History

When the call to a function doesn't have any side effects, what is the point of making the call if the results are ignored? In such case, either the function call is useless and should be dropped or the source code doesn't behave as expected.
2021-02-02 15:02:10 +01:00
This rule raises an issue when the results of the following methods are ignored:
* LINQ method,
2021-01-27 13:42:22 +01:00
* ``++[Pure]++`` method,
* any method on ``++string++``, ``++int++``, ..., ``++System.Collections.Immutable.ImmutableArray<T>++``, ``++ImmutableHashSet<T>++``, ...
Notes:
2021-01-27 13:42:22 +01:00
* although ``++string.Intern++`` has a side effect, ignoring its return value is still suspicious as it is the only reference ensured to point to the intern pool.
* Link methods can have side effects if they are misused. Example:
----
tests.All(c => { c.myfield = "foo"; return true; });
----
Such code should be rewritten as a normal loop.
== Noncompliant Code Example
----
coll.Where(i => i > 5).Select(i => i*i); // Noncompliant
"this string".Equals("other string"); // Noncompliant
----
== Compliant Solution
----
var res = coll.Where(i => i > 5).Select(i => i*i);
var isEqual = "this string".Equals("other string");
----
== Exceptions
2021-01-27 13:42:22 +01:00
This rule doesn't report issues on method calls with ``++out++`` or ``++ref++`` arguments.
include::../see.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Comments And Links
(visible only on this page)
include::comments-and-links.adoc[]
endif::env-github,rspecator-view[]