Строки документации
Урок 8 из 28 курса Clean Code — пишите код лучше на Python на Coddy.
Строка документации или Docstring чаще всего встречается в качестве первой инструкции в определении модуля, функции, класса или метода.
Объявите docstring, заключив строку в """ или ''', например:
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
...посмотрите, как она документирует функцию complex(real, imag).
Обратите внимание на отступ тела документации и
"""
После использования docstring таким образом вы можете использовать свойство __doc__ для получения документации,
complex.__doc__Выведет следующее:
Form a complex number.
Parameters:
real (float) -- the real part (default 0.0)
imag (float) -- the imaginary part (default 0.0)
Задание
ЛегкоВам дана функция с блочным комментарием вместо строки документации (docstring).
Ваша задача — заменить его на валидную строку документации (docstring), проверьте тестовый случай, чтобы добиться правильного форматирования строки документации!
Попробуйте сами
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__)