rspec/rules/S2798/rpg/rule.adoc
Fred Tingaud 16f6c0aecf
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

46 lines
1.1 KiB
Plaintext

== Why is this an issue?
Having all the pieces in front of you makes it easier to understand and debug or maintain a piece of code. Unfortunately, that's often not the case with compile-time arrays, since they are often separated from the code that uses them by many, many lines. Instead, data structures are often a better option.
=== Noncompliant code example
[source,rpg]
----
D directions S 5 0 dim(4) ctdata perrcd(1)
----
=== Compliant solution
[source,rpg]
----
D dirData DS
D 5 Inz('North')
D 5 Inz('South')
D 5 Inz('East')
D 5 Inz('West')
D directions 5 Dim(4) Overlay(dirData)
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Move this array into a data structure
'''
== Comments And Links
(visible only on this page)
=== on 2 Apr 2015, 19:03:30 Ann Campbell wrote:
http://www.bmeyers.net/faqs/14-tips/32-rpg-iv-style?start=3
endif::env-github,rspecator-view[]