Dokumentation
Grundlagen der Softwareentwicklung in Python
Adam Spannbauer
Machine Learning Engineer at Eastman
Dokumentation in Python
- Kommentare
# Quadriere die Zahl x
- Docstrings
"""Quadriere die Zahl x
:param x: Zahl zum Quadrieren
:return: x im Quadrat
>>> square(2)
4
"""
Kommentare
# Dies ist ein gültiger Kommentar
x = 2
y = 3 # Dies ist auch ein gültiger Kommentar
# Du siehst mich nur im Quellcode# Hallo zukünftige Mitwirkende!!
Effektive Kommentare
Was kommentieren
# Definiere Personen als 5
people = 5
# Multipliziere Personen mit 3
people * 3
Warum kommentieren
# Es werden 5 Personen zur Party kommen
people = 5
# Wir brauchen 3 Pizzastücke pro Person
people * 3
Docstrings
def function(x):
"""Hochlevel-Beschreibung der Funktion
Zusätzliche Details zur Funktion
Docstrings
def function(x):
"""Hochlevel-Beschreibung der Funktion
Zusätzliche Details zur Funktion
:param x: Beschreibung von Parameter x
:return: Beschreibung des Rückgabewerts
Beispiel-Webseite, die aus einem Docstring im Flask-Paket generiert wurde.
Docstrings
def function(x):
"""Hochlevel-Beschreibung der Funktion
Zusätzliche Details zur Funktion
:param x: Beschreibung von Parameter x
:return: Beschreibung des Rückgabewerts
>>> # Beispiel für Funktionsnutzung
Erwartete Ausgabe der Beispielnutzung
"""
# Funktionscode
Beispiel-Docstring
def square(x):
"""Quadriere die Zahl x
:param x: Zahl zum Quadrieren
:return: x im Quadrat
>>> square(2)
4
"""
# `x * x` ist schneller als `x ** 2`
# Referenz: https://stackoverflow.com/a/29055266/5731525
return x * x
Beispiel-Docstring-Ausgabe
help(square)
square(x)
Quadriere die Zahl x
:param x: Zahl zum Quadrieren
:return: x im Quadrat
>>> square(2)
4
Lass uns üben!
Grundlagen der Softwareentwicklung in Python
