
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.
72 lines
1.2 KiB
Plaintext
72 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[]
|