** * Dieser Artikel ist von Udemy "[Einführung in Python3, unterrichtet von aktiven Silicon Valley-Ingenieuren + Anwendung + Code-Stil im amerikanischen Silicon Valley-Stil](https://www.udemy.com/course/python-beginner/" Einführung in Python3, unterrichtet von aktiven Silicon Valley-Ingenieuren + Anwendung + Code-Stil im amerikanischen Silicon Valley-Stil ")" Es ist eine Klassennotiz für mich, nachdem ich den Kurs von belegt habe. Es ist mit Genehmigung des Ausbilders Jun Sakai für die Öffentlichkeit zugänglich. ** **.
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
Ich habe einmal eine Beispielfunktion vorbereitet. Als Beschreibung dieses Beispiels würde ich normalerweise über der Beschreibungszeile einen Kommentar abgeben. Im Falle einer Funktion versprechen wir, sie am Anfang des Inneren zu schreiben.
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.
Sie können die Funktion docstrins mit der Methode .__ doc__ aufrufen.
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.
Sie können docstrings auch mit Hilfe aufrufen.