Dokumentationsstrings

Lektion 8 von 28 im Kurs Clean Code - Schreibe besseren Code mit Python von Coddy.

Dokumentationszeichenfolge oder Docstring tritt meistens als erste Anweisung in einer Modul-, Funktions-, Klassen- oder Methodendefinition auf.

Du deklarierst einen Docstring, indem du die Zeichenfolge beispielsweise mit """ oder ''' umschließt:

def complex(real=0.0, imag=0.0):
	"""
	Erzeuge eine komplexe Zahl.
	
		Parameter:
			real (float) -- der Realteil (Standard 0.0)
			imag (float) -- der Imaginärteil (Standard 0.0)
	"""
    if imag == 0.0 and real == 0.0:
        return complex_zero
    ...

Sieh dir an, wie die Funktion complex(real, imag) dokumentiert wird.

Beachte die Einrückung des Docstring-Inhalts und das """.

Nachdem du einen Docstring auf diese Weise verwendet hast, kannst du die Eigenschaft __doc__ verwenden, um die Dokumentation abzurufen:

complex.__doc__

Dies gibt Folgendes aus:

Form a complex number.
	
	Parameters:
		real (float) -- the real part (default 0.0)
		imag (float) -- the imaginary part (default 0.0)

Aufgabe

Einfach

Dir wird eine Funktion mit einem Blockkommentar anstelle eines Docstrings gegeben.

Deine Aufgabe besteht darin, ihn durch einen gültigen Docstring zu ersetzen. Überprüfe den Testfall, um die richtige Formatierung des Docstrings zu erreichen!

Probier es selbst

def sum_binary(a, b):
    # Calculate sum of two integers in binary formmated string
    # Parameters:
    # a (int) -- Integer number
    # b (int) -- Another integer number
    # Returns:
    # binary_sum (str) -- The sum of a and b in binary format
    sum = a + b
    binary_sum = bin(sum)
    return str(binary_sum)[1:] # Final formmating

print(sum_binary.__doc__)