python / beginner
Snippet
Code mit Docstrings dokumentieren
Docstrings sind Zeichenfolgen, die direkt nach einer Funktionsdefinition verwendet werden, um zu erklären, was die Funktion tut. Sie verwenden dreifache Anführungszeichen.
snippet.py
1
2
3
def calculate_area(radius):"""Calculates the area of a circle."""return 3.14 * radius * radius
Erklärung
1
"""Calculates the area of a circle."""
Ein Dokumentationsstring, der den Zweck der Funktion beschreibt.
2
return 3.14 * radius * radius
Die mathematische Logik, die das Ergebnis an den Aufrufer zurückgibt.