Блочные комментарии
Урок 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)Все уроки раздела Clean Code — пишите код лучше на Python
Потренируйтесь самостоятельно: Онлайн-компилятор Python