Is there a way to create multiline comments in Python

Question

I have recently started studying Python  but I couldn t find how to implement multi-line comments  Most languages have block comment symbols like           I tried this in Python  but it throws an error  so this probably is not the correct way  Does Python actually have a multiline comment feature

User · Answer

The inline comments in Python starts with a hash character.

hello = "Hello!" # This is an inline comment
print(hello)

Hello!

Note that a hash character within a string literal is just a hash character.

dial = "Dial #100 to make an emergency call."
print(dial)

Dial #100 to make an emergency call.

A hash character can also be used for single or multiple lines comments.

hello = "Hello"
world = "World"
# First print hello
# And print world
print(hello)
print(world)

Hello

World

Enclose the text with triple double quotes to support docstring.

def say_hello(name):
    """
    This is docstring comment and
    it's support multi line.
    :param name it's your name
    :type name str
    """
    return "Hello " + name + '!'


print(say_hello("John"))

Hello John!

Enclose the text with triple single quotes for block comments.

'''
I don't care the parameters and
docstrings here.
'''

User · Answer

Visual Studio Code universal official multi-line comment toggle    macOS  Select code-block and then       Windows  Select code-block and then Ctrl

User · Answer

You can use the following  This is called DockString   def my function arg1               Summary line      Extended description of function      Parameters      arg1  int   Description of arg1     Returns      int  Description of return value             return arg1  print my function   doc

User · Answer

There is no such feature as a multi-line comment    is the only way to comment a single line of code  Many of you answered     a comment     this as their solution   It seems to work  but internally     in Python takes the lines enclosed as a regular strings which the interpreter does not ignores like comment using     Check the official documentation here

User · Answer

Unfortunately stringification can not always be used as commenting out  So it is safer to stick to the standard prepending each line with a     Here is an example   test1    1  2  3  4           test1 contains 4 integers  test2    1  2     3  4        test2 contains 2 integers   and the string    3  4

User · Answer

Among other answers  I find the easiest way is to use the IDE comment functions which use the Python comment support of     I am using Anaconda Spyder and it has    Ctrl   1 - Comment uncomment Ctrl   4 - Comment a block of code Ctrl   5 - Uncomment a block of code   It would comment uncomment a single multi line s of code with     I find it the easiest   For example  a block comment                                                                                         Sample Commented code in spyder    Hello  World

User · Answer

Well  you can try this  when running the quoted  the input to the first question should quoted with          print  What s your name     myName   input   print  It s nice to meet you     myName  print  Number of characters is    print len myName   age   input  What s your age     print  You will be     str int age  1      next year         a   input   print a  print a 5    Whatever enclosed between     will be commented   If you are looking for single-line comments then it s

User · 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  quot pro tip quot   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 · Answer

For commenting out multiple lines of code in Python is to simply use a   single-line comment on every line     This is comment 1   This is comment 2    This is comment 3   For writing    proper    multi-line comments in Python is to use multi-line strings with the     syntax Python has the documentation strings  or docstrings  feature  It gives programmers an easy way of adding quick notes with every Python module  function  class  and method       This is multiline comment       Also  mention that you can access docstring by a class object like this  myobj   doc

User · Answer

AFAIK  Python doesn t have block comments  For commenting individual lines  you can use the   character   If you are using Notepad    there is a shortcut for block commenting  I m sure others like gVim and Emacs have similar features

User · Answer

If you put a comment in      long comment here       in the middle of a script  Python linters won t recognize that  Folding will be messed up  as the above comment is not part of the standard recommendations  It s better to use    Long comment   here    If you use Vim  you can plugins like commentary vim  to automatically comment out long lines of comments by pressing Vjgcc  Where Vj selects two lines of code  and gcc comments them out   If you don   t want to use plugins like the above you can use search and replace like       1s      g   This will replace the first character on the current and next line with

User · Answer

Select the lines that you want to comment and then use Ctrl     to comment or uncomment the Python code in the Sublime Text editor   For single line you can use Shift

User · Answer

In Python 2 7 the multiline comment is       This is a multilline comment       In case you are inside a class you should tab it properly   For example   class weather2              def getStatus code self  url          world url   url        result   requests get url         return result status code

User · Answer

If you write a comment in a line with a code  you must write a comment  leaving 2 spaces before the   sign and 1 space before the   sign print  quot Hello World quot      printing  If you write a comment on a new line  you must write a comment  leaving 1 space kn in the   sign   single line comment  To write comments longer than 1 line  you use 3 quotes  quot  quot  quot  This is a comment written in more than just one line  quot  quot  quot

User · Answer

On Python 2 7 13   Single    A sample single line comment     Multiline       A sample multiline comment on PyCharm

User · Answer

A multiline comment doesn t actually exist in Python  The below example consists of an unassigned string  which is validated by Python for syntactical errors   A few text editors  like Notepad    provide us shortcuts to comment out a written piece of code or words   def foo         This is a doc string         A single line comment                This        is a multiline        comment String                     print  This is a sample foo function      print  This function has no arguments              return True   Also  Ctrl   K is a shortcut in Notepad   to block comment  It adds a   in front of every line under the selection  Ctrl   Shift   K is for block uncomment

User · Answer

Yes  it is fine to use both       Comments       and      Comments       But  the only thing you all need to remember while running in an IDE  is you have to  RUN  the entire file to be accepted as multiple lines codes  Line by line  RUN  won t work properly and will show an error

User · Answer

I think it doesn t  except that a multiline string isn t processed  However  most  if not all Python IDEs have a shortkey for  commenting out  multiple lines of code

User · Answer

Multiline comment in Python   For me  both     and     worked   Example   a   10 b   20 c   a b     print   hello       print   Addition is     a b    Example   a   10 b   20 c   a b     print  hello       print  Addition is     a b

User · Answer

Using PyCharm IDE      You can comment and uncomment lines of code using Ctrl      Ctrl   comments or uncomments the current line or several selected lines with single line comments     in Django templates  or   in Python scripts     Pressing Ctrl Shift   for a selected block of source code in a Django template surrounds the block with    comment    and    endcomment    tags          n   5 while n  gt  0      n -  1     if n    2          break     print n   print  Loop ended      Select all lines then press Ctrl          n   5   while n  gt  0        n -  1       if n    2            break       print n     print  Loop ended

User · Answer

I would advise against using     for multi line comments   Here is a simple example to highlight what might be considered an unexpected behavior   print     n    format       I am a string               Some people consider me a     multi-line comment  but              clearly I am also a string            Now have a look at the output   I am a string      Some people consider me a     multi-line comment  but     clearly I am also a string   The multi line string was not treated as comment  but it was concatenated with  clearly I m also a string  to form a single string   If you want to comment multiple lines do so according to PEP nbsp 8 guidelines   print     n    format       I am a string         Some people consider me a       multi-line comment  but      clearly I am also a string            Output   I am a string clearly I am also a string

User · Answer

Python does have a multiline string comment syntax in the sense that unless used as docstrings  multiline strings generate no bytecode -- just like  -prepended comments  In effect  it acts exactly like a comment   On the other hand  if you say this behavior must be documented in the official documentation to be a true comment syntax  then yes  you would be right to say it is not guaranteed as part of the language specification   In any case  your text editor should also be able to easily comment-out a selected region  by placing a   in front of each line individually   If not  switch to a text editor that does   Programming in Python without certain text editing features can be a painful experience  Finding the right editor  and knowing how to use it  can make a big difference in how the Python programming experience is perceived   Not only should the text editor be able to comment-out selected regions  it should also be able to shift blocks of code to the left and right easily  and it should automatically place the cursor at the current indentation level when you press Enter  Code folding can also be useful     To protect against link decay  here is the content of Guido van Rossum s tweet       BSUCSClub Python tip  You can use multi-line strings as multi-line comments  Unless used as docstrings  they generate no code   -

User · Answer

From the accepted answer        You can use triple-quoted strings  When they re not a docstring  first thing in a class function module   they are ignored    This is simply not true  Unlike comments  triple-quoted strings are still parsed and must be syntactically valid  regardless of where they appear in the source code   If you try to run this code     def parse token token               This function parses a token      TODO  write a decent docstring  -               if token       and           do something        elif token       or           do something else        elif token       xor                       Note that we still need to provide support for the deprecated         token  xor  Hopefully we can drop support in libfoo 2 0                      do a different thing        else          raise ValueError   You ll get either     ValueError  invalid  x escape      on Python 2 x or     SyntaxError   unicode error   unicodeescape  codec can t decode bytes in position 79-80  truncated  xXX escape      on Python 3 x   The only way to do multi-line comments which are ignored by the parser is     elif token       xor         Note that we still need to provide support for the deprecated       token  xor  Hopefully we can drop support in libfoo 2 0      do a different thing

[python] Is there a way to create multiline comments in Python?

Examples related to python

Examples related to comments

Examples related to documentation