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.
|
|
|
|
|
|
2021-04-28 18:08:03 +02:00
|
|
|
|
2021-04-28 16:49:39 +02:00
|
|
|
== Noncompliant Code Example
|
|
|
|
|
|
|
|
|
|
----
|
|
|
|
|
UNCOMMENTED-SECTION SECTION.
|
|
|
|
|
----
|
|
|
|
|
|
2021-04-28 18:08:03 +02:00
|
|
|
|
2021-04-28 16:49:39 +02:00
|
|
|
== Compliant Solution
|
|
|
|
|
|
|
|
|
|
----
|
|
|
|
|
* Some comments
|
|
|
|
|
CORRECTLY-COMMENTED-SECTION SECTION.
|
|
|
|
|
|
|
|
|
|
ANOTHER-CORRECTLY-COMMENTED-SECTION SECTION.
|
|
|
|
|
* Some comments
|
|
|
|
|
----
|
2021-04-28 18:08:03 +02:00
|
|
|
|
|
|
|
|
|
2021-06-02 20:44:38 +02:00
|
|
|
|
|
|
|
|
ifdef::rspecator-view[]
|
|
|
|
|
== Comments And Links
|
|
|
|
|
(visible only on this page)
|
|
|
|
|
|
|
|
|
|
include::comments-and-links.adoc[]
|
|
|
|
|
endif::rspecator-view[]
|
