rspec/rules/S2488/plsql/rule.adoc

42 lines
680 B
Plaintext
Raw Normal View History

== 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
=== 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 */
----
=== 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 */
----
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[]