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