2023-05-03 11:06:20 +02:00
|
|
|
== Why is this an issue?
|
|
|
|
|
2021-04-28 16:49:39 +02:00
|
|
|
Multi-line comments are more readable when each line is aligned using the "*" character. At most one violation is created for each comment
|
|
|
|
|
2021-04-28 18:08:03 +02:00
|
|
|
|
2023-05-03 11:06:20 +02:00
|
|
|
=== Noncompliant code example
|
2021-04-28 16:49:39 +02:00
|
|
|
|
2022-02-04 17:28:24 +01:00
|
|
|
[source,sql]
|
2021-04-28 16:49:39 +02:00
|
|
|
----
|
|
|
|
/*
|
|
|
|
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 */
|
|
|
|
----
|
|
|
|
|
2021-04-28 18:08:03 +02:00
|
|
|
|
2023-05-03 11:06:20 +02:00
|
|
|
=== Compliant solution
|
2021-04-28 16:49:39 +02:00
|
|
|
|
2022-02-04 17:28:24 +01:00
|
|
|
[source,sql]
|
2021-04-28 16:49:39 +02:00
|
|
|
----
|
|
|
|
/*
|
|
|
|
* this is much better Compliant
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* this is Compliant */
|
|
|
|
----
|
2021-04-28 18:08:03 +02:00
|
|
|
|
2021-09-20 15:38:42 +02:00
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
|
|
|
|
'''
|
|
|
|
== Implementation Specification
|
|
|
|
(visible only on this page)
|
|
|
|
|
2023-05-25 14:18:12 +02:00
|
|
|
=== Message
|
|
|
|
|
|
|
|
Start the lines in this comment block with "*".
|
|
|
|
|
2021-09-20 15:38:42 +02:00
|
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|