Ciągi dokumentacyjne

Lekcja 8 z 28 w kursie Czysty kod — pisz lepszy kod w Pythonie w Coddy.

Ciąg dokumentacyjny (docstring) występuje zazwyczaj jako pierwsza instrukcja w definicji modułu, funkcji, klasy lub metody.

Zadeklaruj docstring, umieszczając ciąg znaków między """ lub ''', na przykład:

def complex(real=0.0, imag=0.0):
	"""
	Utwórz liczbę zespoloną.
	
		Parameters:
			real (float) -- część rzeczywista (domyślnie 0.0)
			imag (float) -- część urojona (domyślnie 0.0)
	"""
    if imag == 0.0 and real == 0.0:
        return complex_zero
    ...

Zobacz, jak dokumentuje funkcję complex(real, imag).

Zwróć uwagę na wcięcie treści docstringa i na """

Po użyciu docstringa w ten sposób możesz użyć właściwości __doc__, aby uzyskać dokumentację.

complex.__doc__

Zostanie wyświetlony następujący wynik:

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

Wyzwanie

Łatwy

Otrzymujesz funkcję z komentarzem blokowym zamiast docstringa.

Twoim zadaniem jest zastąpienie go prawidłowym docstringiem. Sprawdź przypadek testowy, aby uzyskać odpowiednie formatowanie docstringa!

Spróbuj swoich sił

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__)