Multiline comments

[macfanpl]

Oneliner start with #

How to make comment block?

[anbu23]

Python does not have a separate syntax for multi line comments. You could use # for each line to be commented

[jefsummers]

Multiline strings are commonly used to get around the limitation. The string definition needs to be properly indented. So,

"""
This is an example of a multi line comment
using a multi line string
"""
def foobar() :
    for idx in range (15) :
        print(idx)
    """
    Done with the loop
    What to do next?
    Probably just return
    """
    return

foobar()

This is also how docstrings are defined.

def fna(alpha, beta) :
    """
    This function does nothing useful.
    alpha should be a number
    beta should be a number
    fna returns the sum of the numbers
    """
    return alpha+beta

print(fna.__doc__)

Output:
    This function does nothing useful.
    alpha should be a number
    beta should be a number
    fna returns the sum of the numbers

[snippsat]

Also help() works if have docstrings in functions or classes.

>>> help(fna)
Help on function fna in module __main__:

fna(alpha, beta)
    This function does nothing useful.
    alpha should be a number
    beta should be a number
    fna returns the sum of the numbers

[pyzyx3qwerty]

Comment block can be done like this :

"""
This is a comment.
This is another comment.
This is the last comment.
"""

# The above lines were a comment block, whereas this is only a one-line comment

[deanhystad]

With how syntax highlighting works I prefer using # for all comments and """ for doc strings and multi-line strings. But I hardly ever use multi-line comments that I don't want to be part of the documentation.

[macfanpl]

OK Thank you everyone for your help.