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.
86 lines
1.2 KiB
Plaintext
86 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default threshold of 8:
|
|
|
|
|
|
[source,csharp]
|
|
----
|
|
switch (myVariable)
|
|
{
|
|
case 0: // Noncompliant: 9 statements in the case
|
|
methodCall1("");
|
|
methodCall2("");
|
|
methodCall3("");
|
|
methodCall4("");
|
|
methodCall5("");
|
|
methodCall6("");
|
|
methodCall7("");
|
|
methodCall8("");
|
|
methodCall9("");
|
|
break;
|
|
case 1:
|
|
...
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
switch (myVariable)
|
|
{
|
|
case 0:
|
|
DoSomething()
|
|
break;
|
|
case 1:
|
|
...
|
|
}
|
|
...
|
|
private void DoSomething()
|
|
{
|
|
methodCall1("");
|
|
methodCall2("");
|
|
methodCall3("");
|
|
methodCall4("");
|
|
methodCall5("");
|
|
methodCall6("");
|
|
methodCall7("");
|
|
methodCall8("");
|
|
methodCall9("");
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.max
|
|
****
|
|
_Integer_
|
|
|
|
----
|
|
8
|
|
----
|
|
|
|
Maximum number of lines of code
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|