rspec/rules/S4668/css/rule.adoc

49 lines
922 B
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
The W3C specifications say comments should be defined using ``++/* ... */++``. The use of ``++//++`` is not supported on all browsers and can lead to unexpected results.
=== Noncompliant code example
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,css]
2021-04-28 16:49:39 +02:00
----
// some comment
a { color: pink; }
----
=== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,css]
2021-04-28 16:49:39 +02:00
----
/* some comment */
a { color: pink; }
----
=== Exceptions
2021-04-28 16:49:39 +02:00
This rule ignores single line comments in ``++less++`` and ``++scss++`` files.
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Replace this // by a valid comment: /* ... */
'''
== Comments And Links
(visible only on this page)
=== on 7 Jun 2018, 09:20:01 Ann Campbell wrote:
\[~alexandre.gigleux] the current title reads to me like it's about comment content, not formatting. I suggest: Comment formatting should be valid
endif::env-github,rspecator-view[]