rspec/rules/S1547/abap/rule.adoc

== 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[]