Перейти к содержимому
КОНТАКТЫ

Закон лживого комментария

ПРОГРАММИРОВАНИЕ И БАГИ

Когда комментарий и код не согласны друг с другом, скорее всего, неправы оба.

— Аноним, компьютерный фольклор
VIDEO.EXE16:9

Комментарии — это фразы, которые программисты оставляют в коде, чтобы объяснить, что он делает. В теории это жест вежливости по отношению к тем, кто придёт следом. На практике это дорожные указатели на дороге, которую тем временем перенесли.

Код меняют, комментарий остаётся. И вот над функцией, которая отправляет письмо директору, написано «считает скидку десять процентов». Кто прав? Никто. Комментарий рассказывает о древнем намерении, код — о современной аварии.

Есть и противоположная школа: гордые программисты, которые не комментируют никогда. Раз было трудно написать, должно быть трудно и понять. Я посередине. Комментирую всегда, но фразами вроде «не трогать». Ничего не объясняет, зато спасает много жизней.