Comments
- Michael Tomaino
- Nov 30, 2016
- 1 min read
Another short post.
Here's something I have hinted at in the past but never formally introduced:
Comments.
Comments are sticky-notes from the programmer.
They could be things to remember such as - what to do next.
They could be things to explain such as - what does this code do?
They could be self-checks such as - this is what should be true leading into this part of code
They could be notes to other programmers or team members
They can contain copyright information
They could contain notes to users
Comments in Python start with the # (once called "octothorp" or "pound sign" now called "hashtag")
On a given line, anything after the # is ignored by the interpreter
Use them.. it's hard to overuse them.
Comments