Wouldn’t reading code be much easier if the author constantly shared their thoughts with you? Commenting is good practice in Python because it helps others (and your future self) understanding your code much better. Writing commented code makes you more productive in the long term!
There are two types of comments: one-line comments and multi-line comments. Let’s dive right into them!
One-line comments begin with the hash (
#) character and reach to the end of the line. The newline character terminates the meaning of the comment—which is for the Python interpreter to ignore the commented text. A special case are inline comments that are used after a regular Python statement but before the newline character. The PEP 8 standard recommends to use them sparingly.
# This is a one-line comment print('hi') # This is an inline comment
While one-line comments terminate by the end of line, multi-line comments span multiple lines to describe code in greater detail. There are two ways to create multi-line comments: (1) enclosing the commenting text in triple quotes
''' to create a documentation string, or (2) creating a block comment by using multiple hash
# characters, one per line. According to the PEP 8 standard, multi-line comments should be avoided.
# 1. Multi-Line Comment: Documentation String def say_hi(): '''Print the string 'hi' to the shell.''' print('hi') # 2. Multi-Line Comment: Block Comment # This is still a comment. It's # called 'Block Comment'.
Exercise: Use Comments to Fix This Faulty Code
The following code snippet is faulty.
Exercise: Use one-line comments, inline comments, block comments, or documentation strings to fix this code. Run the code to check if the output is:
Comments are great!
You’ll find the correct solution at the end of this article!
Where to Go From Here?
Enough theory, let’s get some practice!
To become successful in coding, you need to get out there and solve real problems for real people. That’s how you can become a six-figure earner easily. And that’s how you polish the skills you really need in practice. After all, what’s the use of learning theory that nobody ever needs?
Practice projects is how you sharpen your saw in coding!
Do you want to become a code master by focusing on practical code projects that actually earn you money and solve problems for people?
Then become a Python freelance developer! It’s the best way of approaching the task of improving your Python skills—even if you are a complete beginner.
Join my free webinar “How to Build Your High-Income Skill Python” and watch how I grew my coding business online and how you can, too—from the comfort of your own home.
#print('Python') print('Comments')#; print('Suck') print('are') #print('not')s=42;print(s) #print('at') #print('all') print('great!')
While working as a researcher in distributed systems, Dr. Christian Mayer found his love for teaching computer science students.
To help students reach higher levels of Python success, he founded the programming education website Finxter.com. He’s author of the popular programming book Python One-Liners (NoStarch 2020), coauthor of the Coffee Break Python series of self-published books, computer science enthusiast, freelancer, and owner of one of the top 10 largest Python blogs worldwide.
His passions are writing, reading, and coding. But his greatest passion is to serve aspiring coders through Finxter and help them to boost their skills. You can join his free email academy here.