Python - Comments

Python comments are programmer-readable explanation or annotations in the Python source code. They are added with the purpose of making the source code easier for humans to understand, and are ignored by Python interpreter. Comments enhance the readabipty of the code and help the programmers to understand the code very carefully.

Just pke most modern languages, Python supports single-pne (or end-of-pne) and multi-pne (block) comments. Python comments are very much similar to the comments available in PHP, BASH and Perl Programming languages.

There are three types of comments available in Python

Single pne Comments

Multipne Comments

Docstring Comments

Single Line Comments

A hash sign (#) that is not inside a string pteral begins a comment. All characters after the # and up to the end of the physical pne are part of the comment and the Python interpreter ignores them.

Example

Following is an example of a single pne comment in Python:

# This is a single pne comment in python

print ("Hello, World!")

This produces the following result −

Hello, World!

You can type a comment on the same pne after a statement or expression −

name = "Madisetti" # This is again comment

Multi-Line Comments

Python does not provide a direct way to comment multiple pne. You can comment multiple pnes as follows −

# This is a comment.
# This is a comment, too.
# This is a comment, too.
# I said that already.

Following triple-quoted string is also ignored by Python interpreter and can be used as a multipne comments:

   
This is a multipne
comment.
   

Example

Following is the example to show the usage of multi-pne comments:

   
This is a multipne
comment.
   

print ("Hello, World!")

This produces the following result −

Hello, World!

Docstring Comments

Python docstrings provide a convenient way to provide a help documentation with Python modules, functions, classes, and methods. The docstring is then made available via the __doc__ attribute.

def add(a, b):
    """Function to add the value of a and b"""
    return a+b

print(add.__doc__)

This produces the following result −

Function to add the value of a and b