[Introduction à l'application Udemy Python3 +] 54. Qu'est-ce que Docstrings?

** * Cet article provient d'Udemy "[Introduction à Python3 enseignée par des ingénieurs actifs de la Silicon Valley + application + style de code de style américain Silicon Valley](https://www.udemy.com/course/python-beginner/" Introduction à Python3 enseignée par des ingénieurs actifs de la Silicon Valley + application + Style de code de style de la Silicon Valley américaine ")" C'est une note de classe pour moi après avoir suivi le cours. Il est ouvert au public avec la permission de l'instructeur Jun Sakai. ** **

■ Description de la description de la fonction

◆ Décrivez dans la fonction

docstrings

def example_func(param1, param2):
    """Example function with types documented in the docstring.
    
    Args:
        param1 (int): The first parameter. 
        param2 (str): The second parameter.
    
    Returns:
        bool: The return value. True for success, False otherwise.
    """
    print(param1)
    print(param2)
    return True

J'ai préparé un exemple de fonction une fois. En tant que description de cet exemple, je commenterais normalement au-dessus de la ligne de description, Dans le cas d'une fonction, nous promettons de l'écrire au début de l'intérieur.

◆ Appeler docstrings

docstrings

def example_func(param1, param2):
    """Example function with types documented in the docstring.

    Args:
        param1 (int): The first parameter.
        param2 (str): The second parameter.

    Returns:
        bool: The return value. True for success, False otherwise.
    """
    print(param1)
    print(param2)
    return True

print(example_func.__doc__)

result

Example function with types documented in the docstring.

    Args:
        param1 (int): The first parameter.
        param2 (str): The second parameter.

    Returns:
        bool: The return value. True for success, False otherwise.

Vous pouvez appeler la fonction docstrins avec la méthode .__ doc__.

◆ Appelez docstrings 2

docstrings

def example_func(param1, param2):
    """Example function with types documented in the docstring.

    Args:
        param1 (int): The first parameter.
        param2 (str): The second parameter.

    Returns:
        bool: The return value. True for success, False otherwise.
    """
    print(param1)
    print(param2)
    return True

help(example_func)

result

Help on function example_func in module __main__:

example_func(param1, param2)
    Example function with types documented in the docstring.
    
    Args:
        param1 (int): The first parameter.
        param2 (str): The second parameter.
    
    Returns:
        bool: The return value. True for success, False otherwise.

Vous pouvez également appeler des docstrings en utilisant help.