16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
51 lines
663 B
Plaintext
51 lines
663 B
Plaintext
== Why is this an issue?
|
|
|
|
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.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,abap]
|
|
----
|
|
DEFINE my_macro.
|
|
...
|
|
END-OF-DEFINITION.
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,abap]
|
|
----
|
|
* here is
|
|
* my comment
|
|
DEFINE my_macro.
|
|
...
|
|
END-OF-DEFINITION.
|
|
----
|
|
|
|
or
|
|
|
|
[source,abap]
|
|
----
|
|
DEFINE my_macro.
|
|
* here is
|
|
* my comment
|
|
...
|
|
END-OF-DEFINITION.
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Document this macro 'XXX'.
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|