Dokumentationsstrings
Lektion 8 von 28 im Kurs Clean Code - Schreibe besseren Code mit Python von Coddy.
Ein Document String oder Docstring tritt meistens als die erste Anweisung in einer Modul-, Funktions-, Klassen- oder Methodendefinition auf.
Deklarieren Sie einen Docstring, indem Sie den String in """ oder ''' einschließen, zum Beispiel:
def complex(real=0.0, imag=0.0):
"""
Form a complex number.
Parameters:
real (float) -- the real part (default 0.0)
imag (float) -- the imaginary part (default 0.0)
"""
if imag == 0.0 and real == 0.0:
return complex_zero
...Schauen Sie sich an, wie er die Funktion complex(real, imag) dokumentiert.
Beachten Sie die Einrückung des Doc-Bodys und der
"""
Nachdem Sie einen Docstring auf diese Weise verwendet haben, können Sie die Eigenschaft __doc__ verwenden, um die Dokumentation abzurufen:
complex.__doc__Dies wird Folgendes ausgeben:
Form a complex number.
Parameters:
real (float) -- the real part (default 0.0)
imag (float) -- the imaginary part (default 0.0)
Aufgabe
EinfachDir wird eine Funktion mit einem Blockkommentar anstelle eines Docstrings gegeben.
Deine Aufgabe ist es, diesen durch einen gültigen Docstring zu ersetzen. Überprüfe den Testfall, um die richtige Formatierung für den Docstring 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__)