rspec/rules/S2688/csharp/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

49 lines
776 B
Plaintext

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
[source,csharp]
----
var a = double.NaN;
if (a == double.NaN) // Noncompliant; always false
{
Console.WriteLine("a is not a number"); // this is dead code
}
if (a != double.NaN) // Noncompliant; always true
{
Console.WriteLine("a is not NaN"); // this statement is not necessarily true
}
----
=== Compliant solution
[source,csharp]
----
if (double.IsNaN(a))
{
console.log("a is not a number");
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Use double.IsNaN() instead.
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]