Секретный код: почему надписи в программе важнее, чем вы думаете
Секретный код: почему надписи в программе важнее, чем вы думаете Вы когда-нибудь пытались собрать сложный конструктор без инструкции? Или найти нужную деталь в коробке, где всё свалено в кучу? Вот так же выглядит программа, в которой нет пояснений. Вроде всё есть, а разобраться — невозможно. Что такое комментарии? Это обычные заметки внутри программы, которые пишет человек. Робот их не видит и не выполняет — они только для людей. Как пометки на полях книги или подписи на коробках с деталями. Они никак не влияют на работу, но без них разобраться в своём же коде через неделю становится настоящим квестом. Почему они важны? Первое: память подводит. Сегодня ты знаешь, что значит эта строчка, а завтра — уже забыл. Комментарий напомнит, зачем ты написал именно так. Экономия времени и нервов. Второе: помощь другим. Если ты работаешь в команде или показываешь свой проект другу, пояснения помогут им быстро понять твою логику. Не придётся переспрашивать «а что это за цифра?». Ты экономишь своё время на объяснениях. Третье: поиск ошибок. Когда программа не работает, комментарии помогают быстрее найти, где ты отклонился от задумки. Это как следы на карте: ты видишь свой путь и понимаешь, где свернул не туда. Как писать комментарии правильно? Не пишите длинные романы. Достаточно одной-двух фраз перед сложным куском. «Здесь мы поворачиваем колёса влево на пол-оборота» «Проверяем, не упёрся ли робот в стену» «Ждём три секунды, пока сработает датчик» Не комментируйте очевидное. Не надо писать «прибавляем единицу» к команде сложения — это и так ясно. Комментируйте смысл шага, а не сам код. Старайтесь писать пояснения сразу, как только написали код. Не откладывайте на потом — забудете, зачем вы это сделали.