23
Мар

Слишком много комментариев

На днях реализовывал алгоритм работы обработчика переноса стопок предметов (по одному предмету, всю стопку сразу или только половину). Пришёл к выводу, что расписывать почти каждую строчку кода для мудрёного кода — очень неплохая идея.

Получилась такая функция:

Комментариев получилось много. Даже очень много. Зато этот код заработал с первого раза, что повысило до планетарных масштабов моё подростковое чувство собственной важности, которое даже заставило меня запостить эту гифку:

По сути, эти комментарии хорошо выполняют свою функцию: человек, далёкий даже от программирования вполне сможет понять представленный код, не говоря уже о матёрых программистах. Но для меня он больше исполнил другую, не менее важную функцию: я сам лучше понимаю свой же код, а время, затраченное на написание комментария нивелировалось за счёт того, что всё-таки человеческий язык при перечитывании понимается куда проще и быстрее, чем синтаксис языка программирования, хоть и подобный человеческому языку. Комментарий раскрывает смысл кода, а код — лишь логику. Важно ведь понимать смысл кода, так ведь?

Кроме того, при написании комментариев невольно получается метод утёнка — когда ты объясняешь какой-то абстрактной сущности (утёнок, кот, твой комп, компилятор, мама, папа) свой код и от того ты сам лучше его понимаешь.

Добавить комментарий

Этот сайт использует Akismet для борьбы со спамом. Узнайте как обрабатываются ваши данные комментариев.