rules.scsslint.Comment.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-web-frontend-scss Show documentation

Consume reports generated by scsslint for code quality. Also consume reports for code duplication (either simian or cpd). The information generated by reports are added in Sonar

There is a newer version: 2.1.0

Show newest version

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)

Configuration Option	Description
`allowed`	Regular expression for matching allowed comments, such as '^[/* ] Copyright'
`style`	Style of comment to enforce (`silent` or `loud`) (default silent)