org.sonar.l10n.javascript.rules.javascript.S139.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javascript-checks Show documentation

There is a newer version: 10.20.0.29356

This rule is deprecated, and will eventually be removed.
Why is this an issue?
This rule verifies that single-line comments are not located at the ends of lines of code. The main idea behind this rule is that in order to be
really readable, trailing comments would have to be properly written and formatted (correct alignment, no interference with the visual structure of
the code, not too long to be visible) but most often, automatic code formatters would not handle this correctly: the code would end up less readable.
Comments are far better placed on the previous empty line of code, where they will always be visible and properly formatted.
Noncompliant code example
var a1 = b + c; // This is a trailing comment that can be very very long

Compliant solution
// This very long comment is better placed before the line of code
var a2 = b + c;