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.
62 lines
2.5 KiB
Plaintext
62 lines
2.5 KiB
Plaintext
== Why is this an issue?
|
|
|
|
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.
|
|
|
|
[source,rpg]
|
|
----
|
|
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
|
|
|
|
[source,rpg]
|
|
----
|
|
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)
|
|
|
|
=== Message
|
|
|
|
Remove the comment from the end of this line
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
=== on 12 Sep 2014, 14:01:42 Ann Campbell wrote:
|
|
\[~pierre-yves.nicolas] we spoke briefly about this rule when the request was first made and you said it seemed feasible. Before I send it out to the requester for vetting, I wanted to double-check that you still feel that way.
|
|
|
|
endif::env-github,rspecator-view[]
|