rspec/rules/S4524/java/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
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.
2023-06-22 10:38:01 +02:00

42 lines
1.0 KiB
Plaintext

== Why is this an issue?
``++switch++`` can contain a ``++default++`` clause for various reasons: to handle unexpected values, to show that all the cases were properly considered, etc.
For readability purposes, to help a developer quickly spot the default behavior of a ``++switch++`` statement, it is recommended to put the ``++default++`` clause at the end of the ``++switch++`` statement.
This rule raises an issue if the ``++default++`` clause is not the last one of the ``++switch++``'s cases.
[source,java]
----
switch (param) {
case 0:
doSomething();
break;
default: // Noncompliant: default clause should be the last one
error();
break;
case 1:
doSomethingElse();
break;
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Move this "default" clause to the end of this "switch" statement.
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]