How do I use docstrings in Python?

How do I use docstrings in Python?

In Python, docstrings are used to describe modules, classes, methods, and functions. You can create a docstring by placing a string literal as the first statement in your function or class.

Can you show me an example of a function with a docstring?

Sure! Here's a simple example:

def add(a, b):
    """Add two numbers and return the result."""
    return a + b

What are the benefits of using docstrings?

Docstrings improve code readability and provide a way to document your code. They can be accessed through the help() function and are useful for other developers who may use your code.

How can I access a function's docstring?

You can access a function's docstring by using the __doc__ attribute. For example, print(add.__doc__) will display the docstring for the add function.