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.
42 lines
680 B
Plaintext
42 lines
680 B
Plaintext
== Why is this an issue?
|
|
|
|
Multi-line comments are more readable when each line is aligned using the "*" character. At most one violation is created for each comment
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,sql]
|
|
----
|
|
/*
|
|
this line is not aligned and ugly Non-Compliant
|
|
no violation is created on this line, even though is it also bad
|
|
*/
|
|
|
|
/* this is Compliant */
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,sql]
|
|
----
|
|
/*
|
|
* this is much better Compliant
|
|
*/
|
|
|
|
/* this is Compliant */
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Start the lines in this comment block with "*".
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|