Skip to content
Advertisement

How do I create multiline comments in Python?

How do I make multi-line comments? Most languages have block comment symbols like:

/*

*/

Advertisement

Answer

You can use triple-quoted strings. When they’re not a docstring (the first thing in a class/function/module), they are ignored.

'''
This is a multiline
comment.
'''

(Make sure to indent the leading ''' appropriately to avoid an IndentationError.)

Guido van Rossum (creator of Python) tweeted this as a “pro tip”.

However, Python’s style guide, PEP8, favors using consecutive single-line comments, like this:

# This is a multiline
# comment.

…and this is also what you’ll find in many projects. Text editors usually have a shortcut to do this easily.

User contributions licensed under: CC BY-SA
3 People found this is helpful
Advertisement