"Commented-out lines of code" is not defined as a rule

• The commented-out-lines-of-code metric must be removed.
• Title : "Avoid commented-out lines of code"
• Description : Here are the main reasons why commented code is a code smell :
  • It always raises more questions than it gives answers
  • Everybody will forget very quickly how relevant the commented code is
  • This is distraction when going down the code as it stops the flow of eyes
  • It is a bad SCM engine : Subversion, CVS and Git are really more trustworthy !
  • The simple fact of understanding why code was commented out in the first place can take a lot of time
• Default priority : Major
• It would be really valuable to not take into account java code between <code>...</code> in javadoc comments

Rule added in 7faee38, but metric was not removed yet.

Current implementation detects 3 violations in code

/*
for (Visitor visitor : visitors){
  visitor.scan(line);
}
*/

whereas in fact would be better to detect only 1.

Other interesting cases are :

// for (Visitor visitor : visitors){
//  visitor.scan(line);
// }

and

/* for (Visitor visitor : visitors){ */
/*  visitor.scan(line); */
/*}*/

And current implementation will not detect violations in code

public void example() {
  /**
   * This is not Javadoc, even if it looks like Javadoc
   * for(Visitor visitor : visitors){
   *   visitor.scan(line);
   * }
   */
}

Moreover commented-out-lines-of-code metric also will be calculated incorrectly.

Rule has been improved in 81cffc0 to properly handle first and last case. In two other cases it still detects 3 violations.

JSNI methods ignored - 72cecec and bb89464.

For the metric I've created separate issue - SONAR-3093

Works well Evgeny. The violation message should be "This block of commented-out lines of code should be removed" instead of "It's better to remove commented-out lines of code"

The next improvement to this implementation could be to group adjacent violations like :

// generateOneViolation();
// generateSecondViolation();
// generateThirdViolation();

But this is not a blocker issue to release Sonar 2.13 as is.

Violation message changed in 19ea0e8.
For the improvement I created separate issue - SONAR-3119

Manually tested

Upcoming IT with a squid-ruling