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.
72 lines
1.4 KiB
Plaintext
72 lines
1.4 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
public class HiddenCatchBlock {
|
|
|
|
public static class CustomException extends Exception {
|
|
}
|
|
|
|
public static class CustomDerivedException extends CustomException {
|
|
}
|
|
|
|
public static void main(String[] args) {
|
|
try {
|
|
throwCustomDerivedException();
|
|
} catch(CustomDerivedException e) {
|
|
// ...
|
|
} catch(CustomException e) { // Noncompliant; this code is unreachable
|
|
// ...
|
|
}
|
|
}
|
|
|
|
private static void throwCustomDerivedException() throws CustomDerivedException {
|
|
throw new CustomDerivedException();
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
public class HiddenCatchBlock {
|
|
|
|
public static class CustomException extends Exception {
|
|
}
|
|
|
|
public static class CustomDerivedException extends CustomException {
|
|
}
|
|
|
|
public static void main(String[] args) {
|
|
try {
|
|
throwCustomDerivedException();
|
|
} catch(CustomDerivedException e) { // Compliant; try-catch block is "catching" only the Exception that can be thrown in the "try"
|
|
//...
|
|
}
|
|
}
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|