Python Comments
What are comments?
- Comments can be used to explain Python code.
- Comments can be used to make the code more readable.
- Can be used to prevent execution when testing code (i.e. turn off a line of code temporarily)
1. Creating a comment
- Comments starts with a
#, and Python will ignore them:
# This is a comment
print("Hello, World!")
Hello, World!
- Comments can be placed at the end of a line, and Python will ignore the rest of the line:
print("Hello, World!") #This is a comment
Hello, World!
- A comment does not have to be text that explains the code, it can also be used to prevent Python from executing code:
#print("Hello, World!")
print("Cheers, Mate!")
Output:
Cheers, Mate!
2. Multi Line Comments
- Python does not really have a syntax for multi line comments.
- To add a multiline comment you could insert a
#for each line:
#This is a comment
#written in
#more than just one line
print("Hello, World!")
Or, not quite as intended, you can use a multi-line strings.
Since Python will ignore string literals that are not assigned to a variable, you can add a multiline string (triple quotes) in your code, and place your comment inside it:
"""
This is a comment
written in
more than just one line
"""
print("Hello, World!")
Using multiline string as comments
As long as the string is not assigned to a variable, Python will read the code, but then ignore it, and you have made a multiline comment.