Внутристрочные комментарии
Урок 7 из 28 курса Clean Code — пишите код лучше на Python на Coddy.
Встроенные комментарии поясняют один оператор в фрагменте кода.
- Пишите встроенные комментарии в той же строке, что и оператор, к которому они относятся.
- Отделяйте встроенные комментарии от оператора двумя или более пробелами.
- Начинайте с
#и одного пробела. - Не используйте их для объяснения очевидного.
Например:
result = check(name) # Проверить, является ли name хорошимВ большинстве случаев вы предпочтёте использовать блоки комментариев вместо встроенных блоков.
Задание
ЛегкоВам дан небольшой фрагмент кода, который выполняет небольшое вычисление для увеличения значения salary; напишите однострочный комментарий, объясняющий эту строку.
Вероятно, это очевидное объяснение, но ради практики мы всё же это сделаем...
Попробуйте сами
salary = 1000
salary = salary * 1.05Все уроки раздела Clean Code — пишите код лучше на Python
Потренируйтесь самостоятельно: Онлайн-компилятор Python