51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
53 lines
797 B
Plaintext
53 lines
797 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
public int NumberOfMinutes(int hours)
|
|
{
|
|
int seconds = 0; // seconds is never used
|
|
return hours * 60;
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
public int NumberOfMinutes(int hours)
|
|
{
|
|
return hours * 60;
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Unused locally created resources in a ``++using++`` statement are not reported.
|
|
|
|
[source,csharp]
|
|
----
|
|
using(var t = new TestTimer()) // t never used, but compliant.
|
|
{
|
|
//...
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|