Comments

  • Write self-documenting code and ignore the rest of this section. Seriously! [link]

  • Write comments in English. [link]

  • Use one space between the leading # character of the comment and the text of the comment. [link]

  • Longer comments should use proper capitalization and punctuation. [link]

  • Avoid superfluous comments. [link]

    # bad
counter += 1 # Increments counter by one.

  • Keep existing comments up-to-date. An outdated comment is worse than no comment at all. [link]

  • Avoid writing comments to explain bad code. Refactor the code to make it self-explanatory. [link]