rules.scsslint.Comment.html Maven / Gradle / Ivy
Details
Prefer //
comments over /* ... */
.
Bad
/* This is a comment that gets rendered */
Good
// This comment never gets rendered
//
comments should be preferred as they don't get rendered in the final
generated CSS, whereas /* ... */
comments do.
Furthermore, comments should be concise, and using /* ... */
encourages multi-line comments which tend to not be concise.
If you want to allow multi-line comments containing certain text, such as
copyright notices, set the allowed
option to a regular expression. This will
allow multi-line comments that match the regular expression.
Configuration Option
Description
allowed
Regular expression for matching allowed comments, such as '^[/* ] Copyright'
style
Style of comment to enforce (silent
or loud
) (default silent)