Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To monitor the respect of Like Bugs and Potential Bugs, Coding Standards Breaches are tracked through the issues mechanism. While it's difficult to match each of the seven deadly coding sins to an analogous deadly spiritual sin, you might associate this sin with sloth - because transgressors are too lazy to learn and follow your team's standards about whether or not to use spaces in if statements. But it may be more appropriate to match this coding sin to the moral sin of pride - pride that the sinner's code is so good he don't need to be bothered with which line you and your teammates all agreed to put the curly brace on. 

Another, perhaps more serious example of this type of sin is the failure to follow naming conventions. Flout the industry standards about naming constants in all upper case, and you invite the coders who come behind you to fall into the kind of subtle bug that can be very hard to diagnose. 

Wherever the infraction falls on the curly brace-to-upper case continuum, this sin is about not following the team-agreed standards. And that lack of compliance means that other people on the team will be tripped up when they try to read this non-compliant code, and at best spend extra time just trying to parse out what's happening - time that could have been used for moving the code base forward.

To monitor the compliance with coding standards, add the Rules Compliance Issues and Technical Debt widget to your dashboard:

Image ModifiedThe Rules Compliance Index (RCI) gives you an overview regarding the respect of coding standards. To understand how the RCI is computed, see Rules Compliance Index definition.

It is possible to check compliance with coding standards on both source code and unit tests code.

Use the differential views to monitor added violationsnew issues.

 

You can set your coding standards (active checkscoding rules, severity, etc.) through the Quality Profiles administration page.

...