rspec/rules/S1103/plsql/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00

34 lines
701 B
Plaintext

== Why is this an issue?
PL/SQL does not support nested C-style (``++/* ... */++``) comments.
=== Noncompliant code example
[source,sql]
----
/*
This is a comment block, for which the ending tag was omitted
It may be difficult to figure out that the following line of code is actually commented
variable = function_call();
/* variable contains the result, this is not allowed, as it is an attempt to create an inner comment */
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]