rspec/rules/S1549/abap/rule.adoc

34 lines
415 B
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
Every macro should be commented to explain its goal and how it works. This comment can be located just before or after the macro definition.
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
----
DEFINE my_macro.
...
END-OF-DEFINITION.
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
----
* here is
* my comment
DEFINE my_macro.
...
END-OF-DEFINITION.
----
or
----
DEFINE my_macro.
* here is
* my comment
...
END-OF-DEFINITION.
----