rspec/rules/S1548/abap/rule.adoc

== Why is this an issue?

Every function should be commented to explain its goal and how it works. This non-empty comment must be located before the function definition.


=== Noncompliant code example

[source,abap]
----
FUNCTION my_function.
  ...
ENDFUNCTION. 
----

=== Compliant solution

[source,abap]
----
* here is  
* my comment
FUNCTION my_function.
  ...
ENDFUNCTION. 
----
ifdef::env-github,rspecator-view[]

'''
== Implementation Specification
(visible only on this page)

=== Message

Document this function 'XXX'.


endif::env-github,rspecator-view[]
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`== Why is this an issue?`

Inline adoc when include has no additional value (#1940) 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. 2023-05-25 14:18:12 +02:00			`Every function should be commented to explain its goal and how it works. This non-empty comment must be located before the function definition.`

Add rules 1000-1999 2020-06-30 12:47:33 +02:00
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`=== Noncompliant code example`
Add rules 1000-1999 2020-06-30 12:47:33 +02:00
RULEAPI-661: Add syntax coloring 2022-02-04 17:28:24 +01:00			`[source,abap]`
Add rules 1000-1999 2020-06-30 12:47:33 +02:00			`----`
			`FUNCTION my_function.`
			`...`
			`ENDFUNCTION.`
			`----`

migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`=== Compliant solution`
Add rules 1000-1999 2020-06-30 12:47:33 +02:00
RULEAPI-661: Add syntax coloring 2022-02-04 17:28:24 +01:00			`[source,abap]`
Add rules 1000-1999 2020-06-30 12:47:33 +02:00			`----`
			`* here is`
			`* my comment`
			`FUNCTION my_function.`
			`...`
			`ENDFUNCTION.`
			`----`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00			`ifdef::env-github,rspecator-view[]`

			`'''`
			`== Implementation Specification`
			`(visible only on this page)`

Inline adoc when include has no additional value (#1940) 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. 2023-05-25 14:18:12 +02:00			`=== Message`

			`Document this function 'XXX'.`

RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`endif::env-github,rspecator-view[]`