Multi-line Comments In Python

Multi-line Comments In Python

13th April 2012 - 3 minutes read time

Python doesn't officially support multi-line comments, but there is a way of implementing the same functionality using an existing language construct. Single line comments in Python are written like this:

# This is a single line comment.

Multi-line comments are not officially supported in Python. That said, you can create the same effect in Python by using a multi-line string. Unless it is part of a docstring at the start of a class, function or module then it parsed into a string variable, but nothing is done with it.

'''
This is
a multiline
comment
'''

Because this is a multi-line string it is therefore parsed by Python, so you will need to be careful what you put in it.

Multi-line strings are used when you want to create a string that is split across several lines. If you create one and don't assign it to a variable then it is just thrown away. Multi-line strings can be used in the following way.

multilinestring = '''
This is
a multiline
string
'''
print multilinestring

Python's style guide, PEP8, favors using consecutive single-line comments, and this is also what you'll find in many projects. Text editors usually have a shortcut to do this easily.

Python

Comments

Nice article. Helpful information.

Comments are an important part of any programming language.

It gives a better understanding of the program.

Submitted by shilkaren on Wed, 09/09/2020 - 13:15

Permalink

Keep up the great work, I read few blog posts on this site and I believe that your website is really interesting and has loads of good info. Lovely blog..! I really enjoyed reading this article. Keep it up!!

Submitted by Vijay on Wed, 01/20/2021 - 08:40

Permalink

Add new comment

The content of this field is kept private and will not be shown publicly.
CAPTCHA
2 + 1 =
Solve this simple math problem and enter the result. E.g. for 1+3, enter 4.
This question is for testing whether or not you are a human visitor and to prevent automated spam submissions.

Related Content

Reading User Files With Tkinter In Python

7th August 2022

The Tkinter library in Python has a number of file dialogs that allow programs to ask for a file from a user. Using these dialogs it is possible to accept a file from a user and read the contents of that file.

Read more

Conway's Game Of Life With Tkinter In Python

28th November 2021

Conway's game of life, was devised by John Conway in 1970 and is a way of modelling very simple cell population dynamics. The game takes place on a two dimensional board containing a grid of orthogonal cells. The game is technically a zero player game in that the initial setup of the game dictates the eventual evolution of the board.

Read more

Using Events With Tkinter Canvas Elements In Python

7th November 2021

There are lots of ways to draw objects using the Tkinter Canvas element, but making the canvas elements interactable adds a lot to the applications you create. There are a few things to take into account when binding events like what events to trigger on and how to find out what item triggered what event.

Read more