Stringhe di documentazione

Lezione 8 di 28 del corso Codice pulito - Scrivi codice migliore con Python di Coddy.

La documentazione in forma di stringa, o docstring, si trova per lo più come prima istruzione nella definizione di un modulo, di una funzione, di una classe o di un metodo.

Dichiara una docstring racchiudendo la stringa tra """ o ''', ad esempio:

def complex(real=0.0, imag=0.0):
	"""
	Forma un numero complesso.
	
		Parameters:
			real (float) -- la parte reale (valore predefinito 0.0)
			imag (float) -- la parte immaginaria (valore predefinito 0.0)
	"""
    if imag == 0.0 and real == 0.0:
        return complex_zero
    ...

guarda come documenta la funzione complex(real, imag).

Nota l'indentazione del corpo della docstring e di """

Dopo aver usato una docstring in questo modo, puoi usare la proprietà __doc__ per ottenere la documentazione,

complex.__doc__

Verrà visualizzato quanto segue,

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

Sfida

Facile

Ti viene fornita una funzione con un commento a blocco al posto della docstring.

Il tuo compito è sostituirlo con una docstring valida; controlla il caso di test per ottenere la formattazione corretta della docstring!

Provalo tu

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