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.
50 lines
636 B
Plaintext
50 lines
636 B
Plaintext
== Why is this an issue?
|
|
|
|
Every subroutine(``++FORM++``) should be commented to explain its goal and how it works. This comment can be located just before or after the form definition.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,abap]
|
|
----
|
|
FORM my_form.
|
|
...
|
|
ENDFORM
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,abap]
|
|
----
|
|
* here is
|
|
* my comment
|
|
FORM my_form.
|
|
...
|
|
ENDFORM
|
|
----
|
|
|
|
or
|
|
|
|
[source,abap]
|
|
----
|
|
FORM my_form.
|
|
* here is
|
|
* my comment
|
|
...
|
|
ENDFORM
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Document this form 'XXX'.
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|