Strings de Documentação
Lição 8 de 28 do curso Clean Code - Escreva códigos melhores com Python da Coddy.
Document String ou Docstring ocorre principalmente como a primeira instrução em uma definição de módulo, função, classe ou método.
Declare uma docstring envolvendo a string com """ ou ''' por exemplo,
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
...veja como ele documenta a função complex(real, imag).
Observe o recuo do corpo do doc e das
"""
Depois de usar uma docstring como esta, você pode usar a propriedade __doc__ para obter a documentação,
complex.__doc__Irá gerar a seguinte saída,
Form a complex number.
Parameters:
real (float) -- the real part (default 0.0)
imag (float) -- the imaginary part (default 0.0)
Desafio
FácilVocê recebeu uma função com um comentário de bloco em vez de uma docstring.
Sua tarefa é substituí-lo por uma docstring válida, verifique o caso de teste para obter a formatação correta para a docstring!
Experimente você mesmo
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__)