Comments

  • Use multi-line comments to describe following paragraphs of code.

  • Use end-of-line comments to describe variable declarations or to clarify a single statement.

  • Do not leave obsolete code fragments within comments as an historical trail. We have a version control system to do that, and old code within comments only confuses others.