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.
62 lines
1.1 KiB
Plaintext
62 lines
1.1 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Nesting ``++try++``/``++catch++`` or ``++@try++``/``++@catch++`` blocks severely impacts the readability of source code because it makes it too difficult to understand which block will catch which exception.
|
|
|
|
|
|
This {cpp} example also applies to Objective-C.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,cpp]
|
|
----
|
|
try {
|
|
try { // Noncompliant
|
|
doSomething();
|
|
} catch (RuntimeException e) {
|
|
/* Ignore */
|
|
}
|
|
|
|
doSomethingElse();
|
|
} catch (Exception e) {
|
|
/* ... */
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,cpp]
|
|
----
|
|
try {
|
|
dedicatedMethod(); // Compliant
|
|
doSomethingElse();
|
|
} catch (Exception e) {
|
|
/* ... */
|
|
}
|
|
|
|
/* ... */
|
|
|
|
private void dedicatedMethod() {
|
|
try { // Compliant
|
|
doSomething();
|
|
} catch (RuntimeException e) {
|
|
/* Ignore */
|
|
}
|
|
}
|
|
----
|
|
|
|
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[]
|