Дзен Python
47
Какие комментарии следует писать?
Главная задача комментария — объяснить, что должен делать ваш код и как он рабо-
тает. В разгаре работы над проектом вы понимаете, как работают все его компонен-
ты. Но если вернуться к проекту спустя некоторое время, скорее всего, некоторые
подробности будут забыты. Конечно, всегда можно изучить код и разобраться в том,
как должны работать его части, но хорошие комментарии с доступным изложением
общих принципов работы кода сэкономят немало времени.
Если вы хотите стать профессиональным программистом или участвовать в со-
вместной работе с другими программистами, научитесь писать осмысленные
комментарии. В наши дни почти все программы разрабатываются коллективно
в группах — либо группами работников одной компании, либо группами энтузиа-
стов, совместно работающих над проектом с открытым кодом. Опытные програм-
мисты ожидают увидеть комментарии в коде, поэтому лучше привыкайте добавлять
содержательные комментарии прямо сейчас. Написание простых, лаконичных
комментариев — одна из самых полезных привычек, необходимых начинающему
программисту.
Принимая решение о том, нужно ли писать комментарий или нет, спросите себя,
пришлось ли вам перебрать несколько вариантов в поисках разумного решения для
некоторой задачи; если ответ будет положительным, напишите комментарий по по-
воду вашего решения. Удалить лишние комментарии позднее намного проще, чем
возвращаться и добавлять комментарии в программу. С этого момента я буду ис-
пользовать комментарии в примерах для пояснения смысла некоторых частей кода.
Достарыңызбен бөлісу: