rspec/rules/S1669/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

40 lines
760 B
Plaintext

== Why is this an issue?
Using keywords as variable names may yield incomprehensible code, and should be avoided.
=== Noncompliant code example
[source,abap]
----
DATA: wa_struct TYPE struct,
name TYPE string,
dob TYPE string,
aliases TYPE string, " ALIASES is a keyword
----
=== Compliant solution
[source,abap]
----
DATA: wa_struct TYPE struct,
name TYPE string,
dob TYPE string,
alt_names TYPE string,
----
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[]