"""

this is a docstring not a multiline comment

and this can be shown in output or not

"""

# mutiline comment

# is like

# that

# and this can not be shown cause it is a comment

def function(a: int, b: str, c = True) -> bool:

    """_summary_

​

    Args:

        a (int): _description_

        b (str): _description_

        c (bool, optional): _description_. Defaults to True.

​

    Returns:

        bool: _description_

    """    

    if a == c:

        return True

    else:

        return False

def functionName():

    """

    This is a function docstring

    """

# DRY : make functions that do only one thing at a time

# None is a good choice for default argument

# See documentation

print(func_name.__doc__)

# Alternative way

import inspect

print(inspect.getdoc(func_name))

help(functionName)

# Docstrings are used create your own Documentation for a function or for a class

# we are going to write a function that akes a name and returns it as a title.

def titled_name(name):

  # the following sting is Docstring

  """This function takes name and returns it in a title case or in other

  words it will make every first letter of a word Capitalized"""

  return f"{name}".title()

Python Docstrings Example

def Add(a,b):

    '''Takes two number as input and returns sum of 2 numbers'''

    return a+b

"""The module's docstring"""

​

class MyClass:

    """The class's docstring"""

​

    def my_method(self):

        """The method's docstring"""

​

def my_function():

    """The function's docstring"""

def complex(real=0.0, imag=0.0):

    """Form a complex number

​

    Args:

        real (float, optional): The real part. Defaults to 0.0.

        imag (float, optional): The imaginary part. Defaults to 0.0.

    """ 

    if imag == 0.0 and real == 0.0:

        return complex_zero

    ...

​