Documentation Strings
Lección 8 de 28 del curso Clean Code - Write better code using Python de Coddy.
La cadena de documentación o Docstring ocurre principalmente como la primera instrucción en la definición de un módulo, función, clase o método.
Declara un docstring envolviendo la cadena con """ o ''' por ejemplo,
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
...echa un vistazo a cómo documenta la función complex(real, imag).
Observa la sangría del cuerpo del doc y las
"""
Después de usar un docstring como este, puedes usar la propiedad __doc__ para obtener la documentación,
complex.__doc__Dará como resultado lo siguiente,
Form a complex number.
Parameters:
real (float) -- the real part (default 0.0)
imag (float) -- the imaginary part (default 0.0)
Desafío
FácilSe te da una función con un comentario de bloque en lugar de un docstring.
Tu tarea es reemplazarlo con un docstring válido, ¡revisa el caso de prueba para lograr el formato correcto para el docstring!
Pruébalo tú mismo
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__)