2023-05-25 14:18:12 +02:00
|
|
|
== Why is this an issue?
|
|
|
|
|
|
|
|
|
|
Nested comments are confusing and can lead maintainers to misunderstand which code is active.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
|
|
|
|
|
|
[source,swift]
|
|
|
|
|
----
|
|
|
|
|
/*
|
|
|
|
|
This is a comment block.
|
|
|
|
|
It may be difficult to figure out that the following line of code is actually commented
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
variable = function_call();
|
|
|
|
|
/* variable contains the result. Noncompliant; inner comment */
|
|
|
|
|
*/
|
|
|
|
|
----
|
|
|
|
|
|
2021-06-02 20:44:38 +02:00
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
ifdef::env-github,rspecator-view[]
|
2021-09-20 15:38:42 +02:00
|
|
|
|
|
|
|
|
'''
|
|
|
|
|
== Implementation Specification
|
|
|
|
|
(visible only on this page)
|
|
|
|
|
|
|
|
|
|
include::../message.adoc[]
|
|
|
|
|
|
2021-06-08 15:52:13 +02:00
|
|
|
'''
|
2021-06-02 20:44:38 +02:00
|
|
|
== Comments And Links
|
|
|
|
|
(visible only on this page)
|
|
|
|
|
|
|
|
|
|
include::../comments-and-links.adoc[]
|
2023-06-22 10:38:01 +02:00
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
endif::env-github,rspecator-view[]
|
