51369b610e
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.
37 lines
891 B
Plaintext
37 lines
891 B
Plaintext
== Why is this an issue?
|
|
|
|
Defining a nested single-line comment within a multi-line comment invites errors. It may lead a developer to wrongly think that the lines located after the single-line comment are not part of the comment.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,pli]
|
|
----
|
|
/*
|
|
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)
|
|
|
|
=== Message
|
|
|
|
Remove this misleading nested comment starting with character "/*"
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|