Chaînes de documentation
Leçon 8 sur 28 du cours Clean Code - Écrire un meilleur code avec Python de Coddy.
La chaîne de documentation ou Docstring apparaît généralement comme la première instruction dans la définition d'un module, d'une fonction, d'une classe ou d'une méthode.
Déclarez une docstring en entourant la chaîne de caractères avec """ ou ''' par exemple,
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
...regardez comment elle documente la fonction complex(real, imag).
Remarquez l'indentation du corps de la doc et des
"""
Après avoir utilisé une docstring comme celle-ci, vous pouvez utiliser la propriété __doc__ pour obtenir la documentation,
complex.__doc__Affichera ce qui suit,
Form a complex number.
Parameters:
real (float) -- the real part (default 0.0)
imag (float) -- the imaginary part (default 0.0)
Défi
FacileOn vous donne une fonction avec un bloc de commentaires au lieu d'une docstring.
Votre tâche consiste à le remplacer par une docstring valide, vérifiez le cas de test pour obtenir le bon formatage de la docstring !
Essayez vous-même
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__)