rspec/rules/S1305/cobol/rule.adoc

== Why is this an issue?

Every section should be commented to explain its goal and how it works. This comment can be placed either just before or just after the section label.


=== Noncompliant code example

[source,cobol]
----
    UNCOMMENTED-SECTION SECTION. 
----


=== Compliant solution

[source,cobol]
----
* Some comments
    CORRECTLY-COMMENTED-SECTION SECTION.     

    ANOTHER-CORRECTLY-COMMENTED-SECTION SECTION.  
* Some comments
----


ifdef::env-github,rspecator-view[]

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

=== Message

Document this section by adding a comment either before or after the section label.


'''
== Comments And Links
(visible only on this page)

=== relates to: S1304

=== on 9 Oct 2013, 00:11:19 Ann Campbell wrote:
The Noncompliant example for this one embeds the compliant examples. Is this sufficient, or should they be split out? Should I be adding a compliant copy of the example?

=== on 10 Oct 2013, 08:51:16 Freddy Mallet wrote:
I've updated the code the description [~ann.campbell.2]

=== on 11 Nov 2013, 12:55:03 Dinesh Bolkensteyn wrote:
I didn't get the double negation part of the title, "Sections should not be left undocumented".


I think "Sections should be documented" is much better.

=== on 13 Nov 2013, 12:06:27 Ann Campbell wrote:
Agreed, [~dinesh.bolkensteyn]

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?`

Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`Every section should be commented to explain its goal and how it works. This comment can be placed either just before or just after the section label.`

Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`=== Noncompliant code example`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00
RULEAPI-661: Add syntax coloring 2022-02-04 17:28:24 +01:00			`[source,cobol]`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`----`
			`UNCOMMENTED-SECTION SECTION.`
			`----`

Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`=== Compliant solution`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00
RULEAPI-661: Add syntax coloring 2022-02-04 17:28:24 +01:00			`[source,cobol]`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`----`
			`* Some comments`
			`CORRECTLY-COMMENTED-SECTION SECTION.`

			`ANOTHER-CORRECTLY-COMMENTED-SECTION SECTION.`
			`* Some comments`
			`----`
Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00

Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00
Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`ifdef::env-github,rspecator-view[]`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`'''`
			`== 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 section by adding a comment either before or after the section label.`

RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
RULEAPI-576: add a horizontal rule between rule description and comments 2021-06-08 15:52:13 +02:00			`'''`
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00			`== Comments And Links`
			`(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			`=== relates to: S1304`

			`=== on 9 Oct 2013, 00:11:19 Ann Campbell wrote:`
			`The Noncompliant example for this one embeds the compliant examples. Is this sufficient, or should they be split out? Should I be adding a compliant copy of the example?`

			`=== on 10 Oct 2013, 08:51:16 Freddy Mallet wrote:`
			`I've updated the code the description [~ann.campbell.2]`

			`=== on 11 Nov 2013, 12:55:03 Dinesh Bolkensteyn wrote:`
			`I didn't get the double negation part of the title, "Sections should not be left undocumented".`


			`I think "Sections should be documented" is much better.`

			`=== on 13 Nov 2013, 12:06:27 Ann Campbell wrote:`
			`Agreed, [~dinesh.bolkensteyn]`

Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`endif::env-github,rspecator-view[]`