comment lines python code example

Example 1: python comments

# this is a comment
# Python ignores comments,
something = 1  # and you can place them after any line of code

"""If you don't want to write a comments using hashtags,
you can put them in a multi-line comment block.
However, if you put hashtags in strings, they do not
create comments.
"""
# comments serve as notes to the programmers
# you can write whatever you want in comments

Example 2: python comments

# Numpy-style python comments for functions
def foo(param_1=True):
  """Example function.

    Parameters
    ----------
    param_1 : bool, optional
        The first parameter (default is True)

    Returns
    -------
    num
        a number
    """
  return -1

Example 3: python comments

# this is a python comment