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.
73 lines
1.2 KiB
Plaintext
73 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
switch (day) {
|
|
case MONDAY:
|
|
case TUESDAY:
|
|
WEDNESDAY: // Noncompliant; syntactically correct, but behavior is not what's expected
|
|
doSomething();
|
|
break;
|
|
...
|
|
}
|
|
|
|
switch (day) {
|
|
case MONDAY:
|
|
break;
|
|
case TUESDAY:
|
|
foo:for(int i = 0 ; i < X ; i++) { // Noncompliant; the code is correct and behaves as expected but is barely readable
|
|
/* ... */
|
|
break foo; // this break statement doesn't relate to the nesting case TUESDAY
|
|
/* ... */
|
|
}
|
|
break;
|
|
/* ... */
|
|
}
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
switch (day) {
|
|
case MONDAY:
|
|
case TUESDAY:
|
|
case WEDNESDAY:
|
|
doSomething();
|
|
break;
|
|
...
|
|
}
|
|
|
|
switch (day) {
|
|
case MONDAY:
|
|
break;
|
|
case TUESDAY:
|
|
compute(args); // put the content of the labelled "for" statement in a dedicated method
|
|
break;
|
|
|
|
/* ... */
|
|
}
|
|
----
|
|
|
|
|
|
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[]
|