Python Syntax Essentials

Comments and Whitespace in Python

Proper use of comments and whitespace is essential for writing clear and readable Python code.

Comments

Comments are lines in your code that are ignored by the Python interpreter. They are used to explain what the code does, making it easier for others (and your future self) to understand your logic. In Python, comments start with the # symbol:

# This is a single-line comment
x = 5  # This is an inline comment

Python does not have a specific syntax for multi-line comments, but you can use several single-line comments in a row:

# This is a comment
# that spans multiple lines

Alternatively, multi-line strings (triple quotes) can be used as docstrings for documentation, but they are not true comments:

"""
This is a docstring, often used
to describe modules, classes, or functions.
"""

Whitespace

Whitespace refers to any space, tab, or newline in your code. In Python, whitespace is significant and affects how code is interpreted. Proper use of whitespace improves code readability and structure.

• Indentation: Python uses indentation (spaces or tabs at the beginning of a line) to define code blocks. Consistent indentation is required.
• Blank Lines: Use blank lines to separate logical sections of code, making it easier to read.
• Spacing Around Operators: Adding spaces around operators and after commas improves clarity.

Example:

# Good use of whitespace
if x > 0:
    print("Positive number")

# Less readable
if(x>0):print("Positive number")

By using comments to explain your code and whitespace to structure it, you make your programs easier to read, maintain, and debug.