rspec/rules/S131/abap/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

57 lines
1014 B
Plaintext

== Why is this an issue?
The requirement for an ``++OTHERS++`` clause is defensive programming. The clause should either take appropriate action, or contain a suitable comment as to why no action is taken.
=== Noncompliant code example
[source,abap]
----
CASE SY-INDEX. // Noncompliant; missing WHEN OTHERS clause
WHEN ONE.
WRITE 'One'.
WHEN 2.
WRITE 'Two'.
ENDCASE.
----
=== Compliant solution
[source,abap]
----
CASE SY-INDEX.
WHEN ONE.
WRITE 'One'.
WHEN 2.
WRITE 'Two'.
WHEN OTHERS. // Compliant
WRITE 'Unexpected result'
ENDCASE.
CASE SY-INDEX.
WHEN OTHERS. // Compliant
WRITE 'Unexpected result'
WHEN ONE.
WRITE 'One'.
WHEN 2.
WRITE 'Two'.
ENDCASE.
----
include::../see.adoc[]
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[]