? Comments in Python

Comments are used to explain code and make it more readable. They are ignored by the Python interpreter during execution. You can use comments to describe what your code does, why a particular approach is used, or add reminders for future changes.

? Types of Comments in Python

1?? Single-Line Comments

A single-line comment starts with the hash (#) symbol. Everything after # on that line is treated as a comment.

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

Example:

# Assigning 10 to variable xx = 10

2?? Multi-Line Comments

Python doesn't have a specific syntax for multi-line comments. However, you can use multiple # symbols or multi-line strings (triple quotes) for this purpose.

? Method 1: Multiple # Symbols

You can write each comment on a new line using #.

# This is a multi-line comment.# It can span across multiple lines.# Each line starts with the hash symbol.

? Method 2: Using Triple Quotes (Not a true comment but works)

You can use triple quotes (""" or ''') for multi-line comments. Technically, this is a multi-line string, but it's often used for comments.

"""This is a multi-line commentusing triple quotes.It spans multiple lines."""

Or:

'''This is another example of a multi-line commentusing single quotes.'''

Note: Multi-line strings (triple quotes) are technically string literals, and they are only ignored if they are not assigned to a variable. If they are assigned, they become part of the code.

? Docstrings in Python

Docstrings are a special kind of comment used to describe the purpose of a function, class, or module. They are enclosed in triple quotes and can span multiple lines. Docstrings are used by documentation tools like Sphinx and can be accessed via the help() function.

Function Docstring Example

def add(a, b):    """    This function takes two numbers as input    and returns their sum.    """    return a + b

You can access a function’s docstring by calling help():

help(add)

This will display:

Help on function add in module __main__:add(a, b)    This function takes two numbers as input    and returns their sum.

? Summary of Comments

• Single-Line Comment: Start with #.

• Multi-Line Comment: Use multiple # symbols or triple quotes (""" or ''').

• Docstrings: Use triple quotes for describing functions, classes, or modules.

Let me know if you need more details or examples! ?