Introduction to Comments and Code Readability

Comments are used to explain code and make it more readable. They are ignored by the Python interpreter and do not affect the execution of the program.

In this lesson, you will learn how to use comments and write clean, readable code.

Single-Line Comments

Single-line comments start with a #. Everything after the # on that line is ignored by Python. For example:

# This is a single-line comment
print("Hello, World!")

Multi-Line Comments

Multi-line comments can be written using triple quotes (''' or """). For example:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

Why Use Comments?

Comments help in:

• Explaining complex code.
• Making code easier to understand for others and your future self.
• Debugging and troubleshooting.

Remember, comments are for humans, not for the machine!

Good Commenting Practices

Here are some tips for writing good comments:

• Keep comments concise and meaningful.
• Avoid obvious comments like # Increment x by 1 for x = x + 1.
• Use comments to explain why the code is written a certain way.

Improving Code Readability

Readable code is easier to maintain and debug. Here are some tips:

• Use meaningful variable and function names.
• Keep lines of code short.
• Organize code into sections using comments.

Commenting Out Code

You can use comments to temporarily disable code for debugging purposes. For example:

# print("This line is commented out and won’t run.")
print("This line will run.")

Example: Documenting a Function

You can use comments to document functions and explain their purpose:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

What Did We Learn?

In this lesson, you learned:

• How to write single-line and multi-line comments in Python.
• The importance of comments for code readability and maintainability.
• Best practices for writing comments and improving code readability.

Great job! Let’s move on to the next topic.