rspec/rules/S2023/rpg/rule.adoc

53 lines
2.2 KiB
Plaintext

Shared coding conventions allow teams to collaborate effectively. To improve readability, blank lines in a program should not have end-of-line comments.
== Noncompliant Code Example
In this example, the second line is blank except for the end-of-line comment, obscuring readability. The seventh line is commented-out, so an end-of-line comment is acceptable.
----
I/COPY VALSRC,VALTEST FIX001
FIX001
** Data structure for subroutine VALDS FIX001
I DS FIX001
I 5 60MMA FIX001
I 7 80DDA FIX001
* FIX001
I DS FIX001
I 5 60MMB FIX001
I 7 80DDB FIX001
----
== Compliant Solution
----
I/COPY VALSRC,VALTEST FIX001
** Data structure for subroutine VALDS FIX001
I DS FIX001
I 5 60MMA FIX001
I 7 80DDA FIX001
* FIX001
I DS FIX001
I 5 60MMB FIX001
I 7 80DDB FIX001
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::comments-and-links.adoc[]
endif::env-github,rspecator-view[]