Code mit Docstrings dokumentieren

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
python
def calculate_area(radius):
    """Calculates the area of a circle."""
    return 3.14 * radius * radius

Erklärung

"""Calculates the area of a circle."""

Ein Dokumentationsstring, der den Zweck der Funktion beschreibt.

return 3.14 * radius * radius

Die mathematische Logik, die das Ergebnis an den Aufrufer zurückgibt.

Vorheriges Snippet Nächstes Snippet

Verwandt

Aus deiner Bibliothek