Комментарии: заметки в твоём коде
Маленькие заметки, которые компьютер пропускает, а люди читают
- простыми словами сказать, что такое комментарий,
- объяснить, почему компьютер игнорирует комментарии, а люди их читают,
- назвать хорошие причины оставлять заметки в коде.
1. Что такое комментарий?
Код полон инструкций — шагов, которые выполняет компьютер. Но в программе может быть и особая строка — комментарий. Комментарий — это заметка для людей. Компьютер как будто её не видит: он проходит мимо и выполняет только настоящие инструкции.
Комментарий отмечают особым знаком, чтобы компьютер знал, что его надо пропустить. Во многих языках это // или # в начале заметки. Знаки пока запоминать не нужно — важна простая мысль: комментарий — это заметка, которую компьютер игнорирует, а люди читают.
2. Зачем оставлять заметки в коде?
Комментарии не ускоряют программу и не делают ничего нового. Так зачем их писать? Потому что код читают люди, а не только компьютеры. Хорошие заметки помогают во многом:
- Объясняют «почему». Код показывает, что происходит; комментарий может сказать, почему ты сделал именно так.
- Помогают будущему тебе. Когда вернёшься через недели, заметка напомнит, о чём ты думал.
- Помогают команде. Другие прочитают твою заметку и быстрее поймут твой код.
- Оставляют напоминания. Короткая заметка «TODO» напомнит доделать что-то позже.
- Выключают код на время. Можно превратить строку в комментарий, чтобы спрятать её на время проверки — не удаляя.
Оставлять понятные заметки — часть работы доброго, внимательного кодера. Это подарок следующему, кто прочитает твой код, — а этот следующий часто ты сам!