Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add no break comment

...

  • the XXX is all capitalized
  • there is no colon or dash char after XXX
  • there is no period at the end
  • description is short (70 chars or less if possible) and helpful
  • the XXX is used to warn other programmers of problematic or misguiding code.

no break comments

When your case will fall through, please add the no break comment with other more detialed comments at the end of the code block.
Example of no break:

Code Block

    switch (*cur) {
    case ']' : // address close
      n_colon = MAX_COLON - 1;
      /* no break */
      /* fall through until ... */
    case ':' : // track colons, fail if too many.

That will help use understand the codes when someone may mistake that as bug. And be more nice to Eclipse CDT code analysis tool.