Блочные комментарии
Урок 6 из 28 курса Clean Code — пишите код лучше на Python на Coddy.
«Если реализацию сложно объяснить — это плохая идея».
— Дзен Python
Комментарии важны для того, чтобы любой, кто будет читать ваш код, мог его понять.
Комментарии в Python делятся на 3 вида:
- Блочные комментарии
- Внутристрочные комментарии
- Строки документации
Давайте начнем с блочных комментариев —
- Начинаются с того же уровня отступа, что и код, который они описывают.
- Каждая строка начинается с символа
#, за которым следует один пробел.
Например,
while i < 10:
# Цикл по i, пока i < 10
# выводим i с новой строкой и увеличиваем на 1
print(i, '\n')
i += 1
Задание
ЛегкоВам дана функция greet, напишите блочный комментарий, чтобы описать своими словами, что делает эта функция.
Следуйте правилам!
Попробуйте сами
def greet(name):
print('Hello', name)