source.dussan.org Git - sonarqube.git/blob

   1 <p>
   2   The check to ensure that requires that comments be the only thing on a line. For the case of // comments that means that the only thing that should precede it is whitespace. It
   3   doesn't check comments if they do not end line, i.e. it accept the following: Thread.sleep( 10 &lt;some comment here&gt; ); Format property is intended to deal with the "} //
   4   while" example.
   5 </p>
   6 <p>
   7   Rationale: Steve McConnel in "Code Complete" suggests that endline comments are a bad practice. An end line comment would be one that is on the same line as actual code. For
   8   example:
   9 </p>
  10 <pre>
  11   <code>
  12     a = b + c; // Some insightful comment
  13     d = e / f; // Another comment for this line
  14   </code>
  15 </pre>
  16
  17 <p>
  18   Quoting "Code Complete" for the justfication:
  19 </p>
  20 <ul>
  21   <li>"The comments have to be aligned so that they do not interfere with the visual structure of the code. If you don't align them neatly, they'll make your listing look like it's
  22     been through a washing machine."
  23   </li>
  24   <li>"Endline comments tend to be hard to format...It takes time to align them. Such time is not spent learning more about the code; it's dedicated solely to the tedious task of
  25     pressing the spacebar or tab key."
  26   </li>
  27   <li>"Endline comments are also hard to maintain. If the code on any line containing an endline comment grows, it bumps the comment farther out, and all the other endline comments
  28     will have to bumped out to match. Styles that are hard to maintain aren't maintained...."
  29   </li>
  30   <li>"Endline comments also tend to be cryptic. The right side of the line doesn't offer much room and the desire to keep the comment on one line means the comment must be short.
  31     Work
  32     then goes into making the line as short as possible instead of as clear as possible. The comment usually ends up as cryptic as possible...."
  33   </li>
  34   <li>"A systemic problem with endline comments is that it's hard to write a meaningful comment for one line of code. Most endline comments just repeat the line of code, which
  35     hurts
  36     more than it helps."
  37   </li>
  38 </ul>
  39 <p>
  40   His comments on being hard to maintain when the size of the line changes are even more important in the age of automated refactorings.
  41 </p>